feat: Add a JSON schema defining the config file format

felipebz · Jul 12, 2024 · efcb4c5 · efcb4c5
1 parent 44e980a
commit efcb4c5
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/schema.json b/schema.json
@@ -0,0 +1,45 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$defs": {
+        "RuleLevel": {
+            "type": "string",
+            "enum": [
+                "on",
+                "off",
+                "info",
+                "minor",
+                "major",
+                "critical",
+                "blocker"
+            ]
+        },
+        "RuleOptions": {
+            "type": "object",
+            "properties": {
+                "level": {
+                    "$ref": "#/$defs/RuleLevel"
+                },
+                "parameters": {
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    },
+    "type": "object",
+    "properties": {
+        "rules": {
+            "additionalProperties": {
+                "oneOf": [
+                    {
+                        "$ref": "#/$defs/RuleLevel"
+                    },
+                    {
+                        "$ref": "#/$defs/RuleOptions"
+                    }
+                ]
+            }
+        }
+    }
+}
diff --git a/zpa-config-example.json b/zpa-config-example.json
@@ -1,4 +1,5 @@
 {
+    "$schema": "schema.json",
     "rules": {
         "EmptyBlock": "minor",
         "ParsingError": "info",