Fixes #312.

structurizr · Jul 19, 2024 · 53519eb · 53519eb
1 parent 2cc351d
commit 53519eb
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 6 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## unreleased
+
+- structurizr-dsl: Fixes https://github.com/structurizr/java/issues/312 (!include doesn't work with files encoded as UTF-8 BOM).
+
 ## 2.2.0 (2nd July 2024)
 
 - structurizr-dsl: Adds support for element/relationship property expressions (https://github.com/structurizr/java/issues/297).

diff --git a/structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslParser.java b/structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslParser.java
@@ -248,6 +248,10 @@ void parse(List<String> lines, File dslFile, boolean include) throws Structurizr
                             for (IncludedFile includedFile : context.getFiles()) {
                                 List<String> paddedLines = new ArrayList<>();
                                 for (String unpaddedLine : includedFile.getLines()) {
+                                    if (unpaddedLine.startsWith(BOM)) {
+                                        // this caters for files encoded as "UTF-8 with BOM"
+                                        unpaddedLine = unpaddedLine.substring(1);
+                                    }
                                     paddedLines.add(leadingSpace + unpaddedLine);
                                 }
 

diff --git a/structurizr-dsl/src/test/resources/dsl/workspace-with-bom-model.dsl b/structurizr-dsl/src/test/resources/dsl/workspace-with-bom-model.dsl
@@ -0,0 +1,6 @@
+    model {
+        user = person "User" "A user of my software system."
+        softwareSystem = softwareSystem "Software System" "My software system, code-named \"X\"."
+
+        user -> softwareSystem "Uses"
+    }
diff --git a/structurizr-dsl/src/test/resources/dsl/workspace-with-bom.dsl b/structurizr-dsl/src/test/resources/dsl/workspace-with-bom.dsl
@@ -1,11 +1,6 @@
 workspace "Getting Started" "This is a model of my software system." {
 
-    model {
-        user = person "User" "A user of my software system."
-        softwareSystem = softwareSystem "Software System" "My software system, code-named \"X\"."
-
-        user -> softwareSystem "Uses"
-    }
+    !include workspace-with-bom-model.dsl
 
     views {
         systemContext softwareSystem "SystemContext" "An example of a System Context diagram." {