feat: improve examples

omissis · Aug 27, 2022 · bd88577 · bd88577
1 parent 7cf0d98
commit bd88577
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/examples/.goarkitect.invalid.yaml b/examples/.goarkitect.invalid.yaml
@@ -0,0 +1,19 @@
+# This file contains non-allowed keys
+---
+rules:
+  - WRONG_name: mandatory files should exist
+    WRONG_kind: file
+    WRONG_matcher:
+      WRONG_kind: "set"
+      WRONG_filePaths:
+        - wrong.json
+        - .envrc.dist
+        - .goarkitect.yaml
+        - .tool-versions.dist
+        - go.mod
+        - go.sum
+        - main.go
+        - README.md
+    WRONG_musts:
+      - WRONG_kind: exist
+    WRONG_because: "they are mandatory for the project to work"
diff --git a/examples/.goarkitect.errors.yaml → examples/.goarkitect.violations.yaml b/examples/.goarkitect.errors.yaml → examples/.goarkitect.violations.yaml
@@ -14,7 +14,7 @@ rules:
         - go.sum
         - main.go
         - README.md
-    mustsa:
+    shoulds:
       - kind: exist
     because: "they are mandatory for the project to work"
   - name: all files in "cmd/" folder are js files