@jimhoyd/urlcode 0.3.0 → 0.4.0-alpha.1

package/schemas/recipe.schema.json

@@ -0,0 +1,138 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/jimhoyd-com/urlcode/main/schemas/recipe.schema.json",
+  "title": "URLCode recipe and example metadata",
+  "description": "The recipe.yaml and example.yaml shape searched by `urlcode recipes search` and `urlcode examples search`. capabilities, targets and routes are derived from the capability preflight and checked by `npm run check`; the rest is written by hand.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "description", "tags", "complexity", "files"],
+  "properties": {
+    "id": {
+      "description": "The directory name under recipes/ or examples/.",
+      "type": "string",
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+      "maxLength": 64
+    },
+    "description": {
+      "description": "One sentence; searched.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 300
+    },
+    "tags": {
+      "description": "Lower-case search words; searched.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": {"type": "string", "pattern": "^[a-z0-9][a-z0-9.-]{0,39}$"}
+    },
+    "complexity": {
+      "enum": ["starter", "intermediate", "advanced"]
+    },
+    "runnable": {
+      "description": "false for a directory with no urlcode.yaml (operator rules, monitoring configuration, scripts). Such entries carry no capabilities, targets or routes.",
+      "type": "boolean",
+      "default": true
+    },
+    "capabilities": {
+      "description": "Derived: every capability name the preflight reports for the project, sorted; searched.",
+      "type": "array",
+      "uniqueItems": true,
+      "items": {"type": "string", "pattern": "^[a-z][a-zA-Z.]{0,39}$"}
+    },
+    "targets": {
+      "description": "Derived: the capability preflight verdict per target. compatible means no issue; otherwise the strongest issue (refused, unknown, conditional).",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["self-hosted", "aws", "vercel", "cloudflare"],
+      "properties": {
+        "self-hosted": {"$ref": "#/$defs/verdict"},
+        "aws": {"$ref": "#/$defs/verdict"},
+        "vercel": {"$ref": "#/$defs/verdict"},
+        "cloudflare": {"$ref": "#/$defs/verdict"}
+      }
+    },
+    "routes": {
+      "description": "Derived: the number of routes after site expansion; the value for --expect-routes.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "services": {
+      "description": "External services the project needs at activation: an operator-installed extension package, a hook endpoint, a store.",
+      "type": "array",
+      "maxItems": 16,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["name", "description"],
+        "properties": {
+          "name": {"type": "string", "minLength": 1, "maxLength": 80},
+          "description": {"type": "string", "minLength": 1, "maxLength": 300}
+        }
+      }
+    },
+    "grants": {
+      "description": "Operator grants the project needs before it activates; none of them come from project files.",
+      "type": "array",
+      "maxItems": 16,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["kind", "description"],
+        "properties": {
+          "kind": {"enum": ["extension", "signals", "proxy", "env", "secret", "link-store", "origin"]},
+          "description": {"type": "string", "minLength": 1, "maxLength": 300}
+        }
+      }
+    },
+    "inputs": {
+      "description": "What to edit before use.",
+      "type": "array",
+      "maxItems": 32,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["name", "file", "description"],
+        "properties": {
+          "name": {"type": "string", "minLength": 1, "maxLength": 80},
+          "file": {"type": "string", "minLength": 1, "maxLength": 200},
+          "description": {"type": "string", "minLength": 1, "maxLength": 300}
+        }
+      }
+    },
+    "files": {
+      "description": "Every file the recipe copies (recipes) or the files worth reading first (examples), project-relative.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 256,
+      "uniqueItems": true,
+      "items": {"type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_][A-Za-z0-9_./-]*$"}
+    },
+    "tests": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["commands"],
+      "properties": {
+        "fixtures": {"description": "The request fixture file, when the project has one.", "type": "string", "maxLength": 200},
+        "commands": {
+          "description": "The exact commands that validate, test and audit the project, run from its directory.",
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 12,
+          "items": {"type": "string", "minLength": 1, "maxLength": 300}
+        }
+      }
+    },
+    "behavior": {
+      "description": "Expected behavior, one observable statement per line.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": {"type": "string", "minLength": 1, "maxLength": 300}
+    }
+  },
+  "$defs": {
+    "verdict": {"enum": ["compatible", "conditional", "refused", "unknown"]}
+  }
+}