@ramon-sg/issue-flow 0.0.0-stage → 0.1.0

package/schema.json

@@ -0,0 +1,281 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/ramon-sg/issue-flow/main/schema.json",
+  "title": "issue-flow config (.agents/flow.json)",
+  "description": "Every key is optional; a missing one takes its default. Unknown keys are an error.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "repo": {
+      "description": "owner/repo. By default, -R, then GH_REPO, then the checkout's origin.",
+      "type": "string",
+      "pattern": "^[^/\\s]+/[^/\\s]+$"
+    },
+    "baseBranch": {
+      "description": "Branch the work starts from and PRs target. By default, the repo's default branch.",
+      "type": "string",
+      "minLength": 1
+    },
+    "branch": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "template": {
+          "description": "Name of an issue's branch. Needs {number} and {slug}; {type} is optional.",
+          "type": "string",
+          "default": "{type}/{number}-{slug}",
+          "allOf": [
+            {
+              "pattern": "\\{number\\}"
+            },
+            {
+              "pattern": "\\{slug\\}"
+            }
+          ]
+        },
+        "namer": {
+          "description": "Who names a branch when the issue has no usable \"Slug de rama\" block: Claude (falls back to the title) or the title.",
+          "enum": [
+            "claude",
+            "title"
+          ],
+          "default": "claude"
+        },
+        "claudeModel": {
+          "description": "Model passed to claude -p --model.",
+          "type": "string",
+          "minLength": 1,
+          "default": "haiku"
+        },
+        "types": {
+          "description": "Branch type of an issue: by label first, then by title prefix (case-insensitive). Each map given replaces its default whole.",
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "labels": {
+              "$ref": "#/$defs/typeMap"
+            },
+            "titlePrefixes": {
+              "$ref": "#/$defs/typeMap"
+            }
+          }
+        }
+      }
+    },
+    "worktrees": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "dir": {
+          "description": "Where issue worktrees go, relative to the repo root.",
+          "type": "string",
+          "minLength": 1,
+          "default": ".claude/worktrees"
+        },
+        "setup": {
+          "description": "Steps that prepare a worktree, in order. They come from the main checkout's config, never the worktree's.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "name",
+              "run"
+            ],
+            "properties": {
+              "name": {
+                "description": "Lowercase letters, digits and dashes; what --only takes.",
+                "type": "string",
+                "pattern": "^[a-z0-9][a-z0-9-]*$"
+              },
+              "run": {
+                "description": "The command, run with sh -c in the worktree. It gets ISSUE_FLOW_WORKTREE, ISSUE_FLOW_MAIN_ROOT, ISSUE_FLOW_DOCKER_SUFFIX and, with ports, ISSUE_FLOW_PORT_BASE.",
+                "type": "string",
+                "minLength": 1
+              },
+              "trusted": {
+                "description": "Run only if the worktree's code is in origin/<base> and has no changes (an install runs the scripts of package.json).",
+                "type": "boolean",
+                "default": false
+              },
+              "once": {
+                "description": "Run once: a mark in the worktree's git dir skips it after it works.",
+                "type": "boolean",
+                "default": false
+              }
+            }
+          },
+          "default": []
+        },
+        "teardown": {
+          "description": "Steps that clean a worktree before it is deleted (bring its Docker down, for example).",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "name",
+              "run"
+            ],
+            "properties": {
+              "name": {
+                "description": "Lowercase letters, digits and dashes; what --only takes.",
+                "type": "string",
+                "pattern": "^[a-z0-9][a-z0-9-]*$"
+              },
+              "run": {
+                "description": "The command, run with sh -c in the worktree. It gets ISSUE_FLOW_WORKTREE, ISSUE_FLOW_MAIN_ROOT, ISSUE_FLOW_DOCKER_SUFFIX and, with ports, ISSUE_FLOW_PORT_BASE.",
+                "type": "string",
+                "minLength": 1
+              }
+            }
+          },
+          "default": []
+        },
+        "ports": {
+          "description": "A block of ports per worktree: true for 1000 blocks of 10 from 20000, or a range. Steps get the block's first port in ISSUE_FLOW_PORT_BASE.",
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "start": {
+                  "type": "integer",
+                  "minimum": 1024,
+                  "default": 20000
+                },
+                "blockSize": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "default": 10
+                },
+                "blocks": {
+                  "type": "integer",
+                  "minimum": 2,
+                  "multipleOf": 2,
+                  "default": 1000
+                }
+              }
+            }
+          ],
+          "default": false
+        },
+        "dockerProjects": {
+          "description": "Prefixes of the worktrees' Docker Compose projects (<prefix>-$ISSUE_FLOW_DOCKER_SUFFIX). The cleanup only deletes projects with one of these and a suffix.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_-]*$"
+          },
+          "default": []
+        }
+      }
+    },
+    "start": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "commitMessage": {
+          "description": "Message of the empty commit that starts an issue; {number} is the issue. [skip ci] keeps CI from running on a commit with no changes.",
+          "type": "string",
+          "minLength": 1,
+          "default": "chore: empieza el trabajo en la issue #{number} [skip ci]"
+        },
+        "prBody": {
+          "description": "Body of the draft PR; {keyword} is Closes, or Part of when the issue has another live branch.",
+          "type": "string",
+          "minLength": 1,
+          "default": "{keyword} #{number}\n\nEn progreso."
+        },
+        "prompt": {
+          "description": "Prompt Claude opens with on a new branch; {number}, {title} (text anyone can write in the issue: better left out).",
+          "type": "string",
+          "minLength": 1,
+          "default": "Issue #{number}. Lee la issue con `npx @ramon-sg/github-rest issue view {number}`, resúmela en lenguaje llano y sigue la skill start-issue para elegir el flujo."
+        },
+        "resumePrompt": {
+          "description": "Prompt Claude opens with on a branch that has a plan; {number}, {title} (text anyone can write in the issue: better left out), {plan}.",
+          "type": "string",
+          "minLength": 1,
+          "default": "Issue #{number}. Lee la issue con `npx @ramon-sg/github-rest issue view {number}`, resúmela en lenguaje llano y retoma el trabajo según {plan}: revisa qué tareas quedan."
+        },
+        "summaryPrompt": {
+          "description": "Prompt of --plan: only summarize and wait; {number}, {title} (text anyone can write in the issue: better left out).",
+          "type": "string",
+          "minLength": 1,
+          "default": "Issue #{number}. Lee la issue con `npx @ramon-sg/github-rest issue view {number}` y resúmela en lenguaje llano. No empieces a trabajar ni a planificar: espera mi pedido."
+        },
+        "summaryPlanPrompt": {
+          "description": "Prompt of --plan when the issue has an open plan; {number}, {title} (text anyone can write in the issue: better left out), {plan}.",
+          "type": "string",
+          "minLength": 1,
+          "default": "Issue #{number}. Lee la issue con `npx @ramon-sg/github-rest issue view {number}` y resúmela en lenguaje llano. Tiene un plan abierto en {plan}: di en una línea qué tareas quedan. No empieces a trabajar ni a planificar: espera mi pedido."
+        },
+        "cloudPrompt": {
+          "description": "What --cloud asks the cloud session: the skill that starts the issue there with --here; {number}, and {flags} (' --new' or ' --resume <branch>' when the branch was chosen here).",
+          "type": "string",
+          "minLength": 1,
+          "default": "/start-issue {number} --yes{flags}"
+        }
+      }
+    },
+    "plans": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "dirs": {
+          "description": "Folders where an issue's plan is looked for, relative to the repo, in order of preference.",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^[^/]"
+          },
+          "default": [
+            "docs/plans",
+            "docs/specs"
+          ]
+        }
+      }
+    },
+    "colors": {
+      "description": "Session color by label prefix; the first entry that starts a label wins. Replaces the default whole.",
+      "type": "object",
+      "additionalProperties": {
+        "enum": [
+          "red",
+          "blue",
+          "green",
+          "yellow",
+          "purple",
+          "orange",
+          "pink",
+          "cyan"
+        ]
+      },
+      "default": {
+        "critical-path": "red",
+        "P1:": "red",
+        "P2:": "orange",
+        "P3:": "yellow",
+        "P4:": "cyan"
+      }
+    }
+  },
+  "$defs": {
+    "typeMap": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string",
+        "pattern": "^[a-z0-9][a-z0-9._-]*$"
+      }
+    }
+  }
+}