From bd885774ca50c900ff84dc8ecb5bcd1c954df0ca Mon Sep 17 00:00:00 2001
From: omissis <claudi0.beatric3@gmail.com>
Date: Sat, 27 Aug 2022 15:53:17 +0200
Subject: [PATCH] feat: improve examples

---
 examples/.goarkitect.invalid.yaml             | 19 +++++++++++++++++++
 ...rrors.yaml => .goarkitect.violations.yaml} |  2 +-
 2 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 examples/.goarkitect.invalid.yaml
 rename examples/{.goarkitect.errors.yaml => .goarkitect.violations.yaml} (98%)

diff --git a/examples/.goarkitect.invalid.yaml b/examples/.goarkitect.invalid.yaml
new file mode 100644
index 0000000..5e92017
--- /dev/null
+++ 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 b/examples/.goarkitect.violations.yaml
similarity index 98%
rename from examples/.goarkitect.errors.yaml
rename to examples/.goarkitect.violations.yaml
index dc5510d..ca00226 100644
--- a/examples/.goarkitect.errors.yaml
+++ b/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