feat(generators): added .gitattributes file and flagged workspace.jso…

…n as binary saw as a suggestion on Structurizr Slack channel. Seemed easy to implement
FormulaMonks · Dec 14, 2024 · ca4d1e6 · ca4d1e6
1 parent 6149640
commit ca4d1e6
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 0 deletions.
diff --git a/e2e/scfz.test.ts b/e2e/scfz.test.ts
@@ -86,6 +86,7 @@ describe("e2e", () => {
                 "environments",
                 "docs",
                 "decisions",
+                ".gitattributes",
                 ".gitignore",
                 "scripts",
                 "containers",

diff --git a/lib/generators/workspace.ts b/lib/generators/workspace.ts
@@ -87,6 +87,11 @@ const generator: GeneratorDefinition<WorkspaceAnswers> = {
             path: "architecture/.gitignore",
             templateFile: "templates/.gitignore",
         } as AddAction<WorkspaceAnswers>,
+        {
+            type: "add",
+            path: "architecture/.gitattributes",
+            templateFile: "templates/.gitattributes",
+        } as AddAction<WorkspaceAnswers>,
         {
             type: "add",
             path: "architecture/.env-arch",

diff --git a/lib/templates/.gitattributes b/lib/templates/.gitattributes
@@ -0,0 +1 @@
+workspace.json binary
diff --git a/lib/templates/bundle.ts b/lib/templates/bundle.ts
@@ -1,4 +1,5 @@
 import envArch from "./.env-arch.hbs";
+import gitattributes from "./.gitattributes";
 import gitignore from "./.gitignore";
 import componentsComponent from "./components/component.hbs";
 import constant from "./constant.hbs";
@@ -24,6 +25,7 @@ import workspace from "./workspace.hbs";
 
 const templatesMap = new Map([
     ["templates/.env-arch", envArch],
+    ["templates/.gitattributes", gitattributes],
     ["templates/.gitignore", gitignore],
     ["templates/components/component.hbs", componentsComponent],
     ["templates/constant.hbs", constant],

diff --git a/lib/types.d.ts b/lib/types.d.ts
@@ -10,6 +10,12 @@ declare module "*.gitignore" {
     export default content;
 }
 
+declare module "*.gitattributes" {
+    const content: string;
+
+    export default content;
+}
+
 declare module "*.sh" {
     const content: string;