@designtools/manifest 0.0.0-stage → 0.1.0

package/schemas/rule.schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/@designtools/manifest/schemas/rule.schema.json",
+  "title": "Design system rule",
+  "description": "One rule, brand or interface, in <system>/rules/<id>.rule.json. Written for people first; agents read the same file through rules.json.",
+  "type": "object",
+  "required": ["kind", "title", "statement", "status"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string" },
+    "kind": { "enum": ["brand", "interface"] },
+    "title": { "type": "string", "description": "A short name: Touch targets." },
+    "statement": { "type": "string", "description": "The rule in one or two sentences." },
+    "rationale": { "type": "string", "description": "Why it exists." },
+    "threshold": { "type": "string", "description": "The measurable line: 44 × 44 CSS px." },
+    "appliesTo": { "type": "array", "items": { "type": "string" }, "description": "Components, elements, assets or pages it governs." },
+    "exceptions": { "type": "array", "items": { "type": "string" } },
+    "tokens": { "type": "array", "items": { "type": "string" }, "description": "Tokens it rests on: --size-2xl." },
+    "status": { "enum": ["confirmed", "assumption"], "description": "Confirmed with the client, or still an assumption." },
+    "check": {
+      "type": "object",
+      "required": ["kind"],
+      "additionalProperties": false,
+      "properties": {
+        "kind": { "enum": ["test", "lint", "audit", "manual"] },
+        "ref": { "type": "string", "description": "The test file, lint rule or audit that proves it." },
+        "description": { "type": "string" }
+      }
+    }
+  }
+}