@zigrivers/scaffold 3.32.1 → 3.33.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -18
- package/content/guides/knowledge-freshness/.diagrams/diagram-0.svg +1 -1
- package/content/guides/knowledge-freshness/.diagrams/manifest.json +1 -1
- package/content/guides/knowledge-freshness/index.html +9 -5
- package/content/guides/knowledge-freshness/index.md +5 -4
- package/content/guides/pipeline/index.html +2 -2
- package/content/guides/pipeline/index.md +2 -2
- package/content/knowledge/VERSION +1 -1
- package/content/knowledge/backend/backend-api-design.md +21 -3
- package/content/knowledge/backend/backend-architecture.md +21 -3
- package/content/knowledge/backend/backend-async-patterns.md +16 -2
- package/content/knowledge/backend/backend-auth-patterns.md +19 -2
- package/content/knowledge/backend/backend-conventions.md +15 -3
- package/content/knowledge/backend/backend-data-modeling.md +19 -3
- package/content/knowledge/backend/backend-deployment.md +21 -3
- package/content/knowledge/backend/backend-dev-environment.md +13 -3
- package/content/knowledge/backend/backend-fintech-broker-integration.md +14 -2
- package/content/knowledge/backend/backend-fintech-compliance.md +23 -4
- package/content/knowledge/mcp-server/mcp-authentication.md +100 -0
- package/content/knowledge/mcp-server/mcp-deployment-patterns.md +119 -0
- package/content/knowledge/mcp-server/mcp-error-handling.md +131 -0
- package/content/knowledge/mcp-server/mcp-observability.md +125 -0
- package/content/knowledge/mcp-server/mcp-prompt-primitives.md +119 -0
- package/content/knowledge/mcp-server/mcp-protocol-fundamentals.md +130 -0
- package/content/knowledge/mcp-server/mcp-resource-design.md +111 -0
- package/content/knowledge/mcp-server/mcp-sdk-selection.md +136 -0
- package/content/knowledge/mcp-server/mcp-testing-strategies.md +127 -0
- package/content/knowledge/mcp-server/mcp-tool-design.md +125 -0
- package/content/knowledge/mcp-server/mcp-transport-patterns.md +122 -0
- package/content/knowledge/mcp-server/mcp-versioning.md +115 -0
- package/content/methodology/custom-defaults.yml +2 -0
- package/content/methodology/deep.yml +2 -0
- package/content/methodology/mcp-server-overlay.yml +88 -0
- package/content/methodology/mvp.yml +2 -0
- package/content/pipeline/build/multi-agent-resume.md +107 -11
- package/content/pipeline/build/multi-agent-start.md +104 -11
- package/content/pipeline/build/single-agent-resume.md +74 -8
- package/content/pipeline/build/single-agent-start.md +69 -12
- package/content/pipeline/finalization/materialize-plan-to-beads.md +473 -0
- package/content/pipeline/foundation/beads.md +6 -0
- package/content/pipeline/planning/implementation-plan-review.md +25 -0
- package/content/pipeline/planning/implementation-plan.md +75 -1
- package/content/pipeline/specification/mcp-tool-resource-contract.md +77 -0
- package/dist/cli/commands/adopt.d.ts.map +1 -1
- package/dist/cli/commands/adopt.js +33 -1
- package/dist/cli/commands/adopt.js.map +1 -1
- package/dist/cli/commands/init.d.ts +6 -0
- package/dist/cli/commands/init.d.ts.map +1 -1
- package/dist/cli/commands/init.js +46 -3
- package/dist/cli/commands/init.js.map +1 -1
- package/dist/cli/init-flag-families.d.ts +6 -1
- package/dist/cli/init-flag-families.d.ts.map +1 -1
- package/dist/cli/init-flag-families.js +59 -2
- package/dist/cli/init-flag-families.js.map +1 -1
- package/dist/cli/init-flag-families.test.js +86 -1
- package/dist/cli/init-flag-families.test.js.map +1 -1
- package/dist/config/schema.d.ts +2310 -126
- package/dist/config/schema.d.ts.map +1 -1
- package/dist/config/schema.js +26 -1
- package/dist/config/schema.js.map +1 -1
- package/dist/config/schema.test.js +75 -2
- package/dist/config/schema.test.js.map +1 -1
- package/dist/config/validators/index.d.ts.map +1 -1
- package/dist/config/validators/index.js +2 -0
- package/dist/config/validators/index.js.map +1 -1
- package/dist/config/validators/mcp-server.d.ts +4 -0
- package/dist/config/validators/mcp-server.d.ts.map +1 -0
- package/dist/config/validators/mcp-server.js +37 -0
- package/dist/config/validators/mcp-server.js.map +1 -0
- package/dist/config/validators/mcp-server.test.d.ts +2 -0
- package/dist/config/validators/mcp-server.test.d.ts.map +1 -0
- package/dist/config/validators/mcp-server.test.js +47 -0
- package/dist/config/validators/mcp-server.test.js.map +1 -0
- package/dist/core/assembly/materialize-plan-to-beads-assembly.test.d.ts +2 -0
- package/dist/core/assembly/materialize-plan-to-beads-assembly.test.d.ts.map +1 -0
- package/dist/core/assembly/materialize-plan-to-beads-assembly.test.js +75 -0
- package/dist/core/assembly/materialize-plan-to-beads-assembly.test.js.map +1 -0
- package/dist/e2e/project-type-overlays.test.js +83 -0
- package/dist/e2e/project-type-overlays.test.js.map +1 -1
- package/dist/project/adopt.d.ts.map +1 -1
- package/dist/project/adopt.js +3 -1
- package/dist/project/adopt.js.map +1 -1
- package/dist/project/detectors/coverage.test.js +1 -0
- package/dist/project/detectors/coverage.test.js.map +1 -1
- package/dist/project/detectors/disambiguate.d.ts.map +1 -1
- package/dist/project/detectors/disambiguate.js +6 -1
- package/dist/project/detectors/disambiguate.js.map +1 -1
- package/dist/project/detectors/disambiguate.test.js +18 -0
- package/dist/project/detectors/disambiguate.test.js.map +1 -1
- package/dist/project/detectors/index.d.ts.map +1 -1
- package/dist/project/detectors/index.js +2 -1
- package/dist/project/detectors/index.js.map +1 -1
- package/dist/project/detectors/mcp-server.d.ts +4 -0
- package/dist/project/detectors/mcp-server.d.ts.map +1 -0
- package/dist/project/detectors/mcp-server.js +91 -0
- package/dist/project/detectors/mcp-server.js.map +1 -0
- package/dist/project/detectors/mcp-server.test.d.ts +2 -0
- package/dist/project/detectors/mcp-server.test.d.ts.map +1 -0
- package/dist/project/detectors/mcp-server.test.js +115 -0
- package/dist/project/detectors/mcp-server.test.js.map +1 -0
- package/dist/project/detectors/types.d.ts +6 -2
- package/dist/project/detectors/types.d.ts.map +1 -1
- package/dist/project/detectors/types.js.map +1 -1
- package/dist/types/config.d.ts +8 -1
- package/dist/types/config.d.ts.map +1 -1
- package/dist/wizard/copy/core.d.ts.map +1 -1
- package/dist/wizard/copy/core.js +4 -0
- package/dist/wizard/copy/core.js.map +1 -1
- package/dist/wizard/copy/index.d.ts.map +1 -1
- package/dist/wizard/copy/index.js +2 -0
- package/dist/wizard/copy/index.js.map +1 -1
- package/dist/wizard/copy/mcp-server.d.ts +3 -0
- package/dist/wizard/copy/mcp-server.d.ts.map +1 -0
- package/dist/wizard/copy/mcp-server.js +40 -0
- package/dist/wizard/copy/mcp-server.js.map +1 -0
- package/dist/wizard/copy/types.d.ts +5 -1
- package/dist/wizard/copy/types.d.ts.map +1 -1
- package/dist/wizard/flags.d.ts +9 -1
- package/dist/wizard/flags.d.ts.map +1 -1
- package/dist/wizard/questions.d.ts +4 -2
- package/dist/wizard/questions.d.ts.map +1 -1
- package/dist/wizard/questions.js +37 -0
- package/dist/wizard/questions.js.map +1 -1
- package/dist/wizard/questions.test.js +107 -0
- package/dist/wizard/questions.test.js.map +1 -1
- package/dist/wizard/wizard.d.ts +3 -2
- package/dist/wizard/wizard.d.ts.map +1 -1
- package/dist/wizard/wizard.js +3 -1
- package/dist/wizard/wizard.js.map +1 -1
- package/package.json +1 -1
|
@@ -123,17 +123,110 @@ These rules are critical for multi-agent operation:
|
|
|
123
123
|
|
|
124
124
|
### Beads Detection
|
|
125
125
|
|
|
126
|
-
|
|
127
|
-
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
126
|
+
The implementation plan is materialized into Beads issues by
|
|
127
|
+
`/scaffold:materialize-plan-to-beads` before the build phase. This block is the
|
|
128
|
+
**defensive preflight** that guarantees the tracker is populated and current
|
|
129
|
+
before any agent claims work — it never claims against an empty or stale tracker.
|
|
130
|
+
Under multi-agent concurrency, materialization is **orchestrator-only** and runs
|
|
131
|
+
**once per wave under a merge-slot lock**; workers never materialize and must
|
|
132
|
+
wait for a run-stamped completion signal before their first claim.
|
|
133
|
+
|
|
134
|
+
**Step 1 — compute `beads_usable`.** `beads_usable` is true only when **all**
|
|
135
|
+
hold: `.beads/` exists, `bd` is on `PATH`, `bd version` parses to **≥ 1.0.5**
|
|
136
|
+
(using a macOS/BSD-safe numeric compare — split major/minor/patch and compare
|
|
137
|
+
numerically, never rely on GNU `sort -V`), and `jq` is on `PATH`. Never write
|
|
138
|
+
`[ -d .beads ] && bd …` as a whole command — it returns exit 1 when `.beads/` is
|
|
139
|
+
absent and breaks callers under `set -e`; use an `if`.
|
|
140
|
+
|
|
141
|
+
**Step 2 — route on the decision table** (this is what prevents the "empty
|
|
142
|
+
tracker looks done" bug):
|
|
143
|
+
|
|
144
|
+
| Condition | Action |
|
|
145
|
+
|---|---|
|
|
146
|
+
| `.beads/` **absent** | Non-Beads project → drive the loop from the markdown playbook/plan (see "Markdown fallback" below). Do **not** call `bd`. |
|
|
147
|
+
| `.beads/` present but `beads_usable` is false (`bd`/`jq` missing or `bd` < 1.0.5) | **Fail closed.** Stop and tell the user to install/upgrade `bd` (≥ v1.0.5) and `jq`. Do **not** markdown-fall-back — Beads may already hold execution state. |
|
|
148
|
+
| `beads_usable`, but the plan has **no** stable task IDs **and** Beads holds no plan-derived issues and no non-bootstrap claimed/closed work | Genuinely legacy plan → markdown loop, and emit "re-run planning to assign stable task IDs". Do **not** claim. |
|
|
149
|
+
| `beads_usable`, plan has no stable IDs **but** Beads already holds plausible build work (claimed/closed non-bootstrap issues) | **Fail closed** — markdown would bypass existing execution state. Require re-running planning + materialization. |
|
|
150
|
+
| `beads_usable`, contract **partially present or malformed** | **Fail closed.** Do **not** markdown-fall-back (would bypass existing plan-derived issues and diverge). Require planning to be re-run/fixed. |
|
|
151
|
+
| `beads_usable` **and a valid stable-ID contract** | **Orchestrator materializes once under the lock, then everyone claims** (see Step 3). |
|
|
152
|
+
|
|
153
|
+
**Step 3 — `beads_usable` + valid contract → orchestrator materializes, workers wait, then claim:**
|
|
154
|
+
|
|
155
|
+
Branch naming: `bd-<id>/<desc>`. Verify `$BEADS_ACTOR` is set per agent (echo it;
|
|
156
|
+
bail if empty).
|
|
157
|
+
|
|
158
|
+
**Two distinct identities.** The merge-slot needs a **per-process unique** holder
|
|
159
|
+
(e.g. `agent-$$` or a UUID) so two local agents sharing one `git user.name` don't
|
|
160
|
+
both think they hold the slot. The **claim/resume actor must stay stable** per
|
|
161
|
+
worktree/session — resolve `BEADS_ACTOR` → `git user.name` → `$USER` (never
|
|
162
|
+
empty). Use the unique value **only** for `bd merge-slot acquire/check/release`;
|
|
163
|
+
keep the stable `BEADS_ACTOR` for `bd ready --claim`. If you must override
|
|
164
|
+
`BEADS_ACTOR` for the lock, scope that override to the lock commands and restore
|
|
165
|
+
the stable actor before claiming.
|
|
166
|
+
|
|
167
|
+
1. **Orchestrator-only materialization under the merge-slot lock.** Only the wave
|
|
168
|
+
orchestrator (the first agent) runs the materializer; workers skip to step 2.
|
|
169
|
+
The orchestrator:
|
|
170
|
+
- **Clears/overwrites any stale completion signal before acquiring the lock**,
|
|
171
|
+
so a signal left from a previous pipeline run (or a pre-update plan) can't
|
|
172
|
+
let workers race ahead of a fresh re-materialization. The **completion
|
|
173
|
+
signal must be run-stamped** — carry a `run_id` or the current plan hash
|
|
174
|
+
(e.g. a metadata flag on the project merge-slot/bootstrap bead, or a
|
|
175
|
+
workspace marker file recording `run_id` / `materialized_at`).
|
|
176
|
+
- **Acquires the lock with a real acquisition loop, not a status poll** — loop
|
|
177
|
+
on `bd merge-slot acquire` itself and re-verify ownership via
|
|
178
|
+
`bd merge-slot check --json` (a released slot is `holder: null` and never
|
|
179
|
+
auto-promotes a waiter, so a check-only loop deadlocks). Guard the
|
|
180
|
+
non-zero/queued return with `|| true` and release via a
|
|
181
|
+
`trap … EXIT INT TERM`.
|
|
182
|
+
- **Once ownership is confirmed, invokes `/scaffold:materialize-plan-to-beads`**
|
|
183
|
+
(the canonical procedure — do not duplicate the four-pass logic). It is
|
|
184
|
+
idempotent and a cheap no-op when already in sync. If it returns non-zero,
|
|
185
|
+
**fail closed** (do not set the signal, do not claim, do not markdown-fall-back).
|
|
186
|
+
- On success, **sets the run-stamped completion signal**, then **releases**
|
|
187
|
+
the slot.
|
|
188
|
+
2. **Workers block on the run-stamped completion signal before their first
|
|
189
|
+
claim.** A released slot (`holder: null`) does **not** prove the orchestrator
|
|
190
|
+
ran — a worker could acquire/release before the orchestrator even started. So
|
|
191
|
+
workers wait until a signal matching **this run's** `run_id`/plan-hash is
|
|
192
|
+
present, then proceed. The lock serializes the *write*; the run-stamped signal
|
|
193
|
+
gates the *readers*.
|
|
194
|
+
3. **Run the scoped claim loop** (using the **stable** `BEADS_ACTOR`, not the
|
|
195
|
+
per-process lock identity). Atomically claim the next ready **plan** task:
|
|
196
|
+
`TASK=$(bd ready --claim --has-metadata-key plan_task_id --json | jq -r '.id')`
|
|
197
|
+
- Scoping to `plan_task_id` keeps the loop from ever claiming the bootstrap
|
|
198
|
+
"initialize Beads" bead or a manually-created issue.
|
|
199
|
+
- This sets `assignee=$BEADS_ACTOR` and `status=in_progress` in a single
|
|
200
|
+
round-trip — eliminates the race window where two agents both see the same
|
|
201
|
+
"ready" task.
|
|
202
|
+
4. Implement following the TDD workflow below.
|
|
203
|
+
5. After the PR is merged: `bd close <id>`.
|
|
204
|
+
6. Repeat the scoped claim (`bd ready --claim --has-metadata-key plan_task_id --json`)
|
|
205
|
+
until it returns no ready task, then run the **completion check**.
|
|
206
|
+
|
|
207
|
+
**Completion check (empty `bd ready` ≠ done).** An empty scoped-ready result does
|
|
208
|
+
**not** mean the build is finished. On an empty result, fetch all plan-derived
|
|
209
|
+
tasks (`bd list --all --limit 0 --has-metadata-key plan_task_id --json`) and
|
|
210
|
+
classify the remaining non-`closed` tasks:
|
|
211
|
+
|
|
212
|
+
- **All plan tasks `closed`** → genuinely **done**; exit gracefully.
|
|
213
|
+
- Otherwise classify **each** remaining non-`closed` task independently — do
|
|
214
|
+
**not** short-circuit on "any task is `in_progress`". Resolve blocker statuses
|
|
215
|
+
from an **unfiltered** `bd list --all --limit 0 --json` (manual blockers carry
|
|
216
|
+
no `plan_task_id`):
|
|
217
|
+
- **advancing** — the task is itself `in_progress`, **or** at least one of its
|
|
218
|
+
**transitive** blockers (walk the chain; bound the walk, reuse
|
|
219
|
+
`bd dep cycles`) is `in_progress`.
|
|
220
|
+
- **stalled** — not `in_progress` and **no** transitive blocker is
|
|
221
|
+
`in_progress`.
|
|
222
|
+
- **All remaining tasks advancing** → exit gracefully (normal multi-agent case;
|
|
223
|
+
other agents are still working).
|
|
224
|
+
- **Any task stalled** → **stop and report the stalled subset**, grouped by why
|
|
225
|
+
(open dependency, manual `blocked`, `deferred`). Unrelated global `in_progress`
|
|
226
|
+
work that blocks none of the stalled tasks does **not** suppress the report.
|
|
227
|
+
|
|
228
|
+
**Markdown fallback** (only when `.beads/` is **absent**, or for a genuinely
|
|
229
|
+
legacy plan per the table — never past existing Beads state):
|
|
137
230
|
- Branch naming: `<type>/<desc>` (e.g., `feat/add-auth`)
|
|
138
231
|
1. Read `docs/implementation-playbook.md` as the primary task execution reference.
|
|
139
232
|
Fall back to `docs/implementation-plan.md` when no playbook is present.
|
|
@@ -96,14 +96,80 @@ Recover your context by checking the current state of work:
|
|
|
96
96
|
|
|
97
97
|
### Beads Recovery
|
|
98
98
|
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
99
|
+
The implementation plan is materialized into Beads issues by
|
|
100
|
+
`/scaffold:materialize-plan-to-beads` before the build phase. A resumed build
|
|
101
|
+
runs the **same defensive preflight** as the start prompt — it never claims
|
|
102
|
+
against an empty or stale tracker.
|
|
103
|
+
|
|
104
|
+
**Step 1 — compute `beads_usable`.** `beads_usable` is true only when **all**
|
|
105
|
+
hold: `.beads/` exists, `bd` is on `PATH`, `bd version` parses to **≥ 1.0.5**
|
|
106
|
+
(using a macOS/BSD-safe numeric compare — split major/minor/patch and compare
|
|
107
|
+
numerically, never rely on GNU `sort -V`), and `jq` is on `PATH`. Never write
|
|
108
|
+
`[ -d .beads ] && bd …` as a whole command — it returns exit 1 when `.beads/` is
|
|
109
|
+
absent and breaks callers under `set -e`; use an `if`.
|
|
110
|
+
|
|
111
|
+
**Step 2 — route on the decision table** (this is what prevents the "empty
|
|
112
|
+
tracker looks done" bug):
|
|
113
|
+
|
|
114
|
+
| Condition | Action |
|
|
115
|
+
|---|---|
|
|
116
|
+
| `.beads/` **absent** | Non-Beads project → drive the loop from the markdown playbook/plan (see "Markdown fallback" below). Do **not** call `bd`. |
|
|
117
|
+
| `.beads/` present but `beads_usable` is false (`bd`/`jq` missing or `bd` < 1.0.5) | **Fail closed.** Stop and tell the user to install/upgrade `bd` (≥ v1.0.5) and `jq`. Do **not** markdown-fall-back — Beads may already hold execution state. |
|
|
118
|
+
| `beads_usable`, plan has **no** stable IDs **and** Beads holds no plan-derived issues and no non-bootstrap claimed/closed work | Genuinely legacy plan → markdown loop, emit "re-run planning to assign stable task IDs". Do **not** claim. |
|
|
119
|
+
| `beads_usable`, plan has no stable IDs **but** Beads already holds plausible build work | **Fail closed** — markdown would bypass existing execution state. |
|
|
120
|
+
| `beads_usable`, contract **partially present or malformed** | **Fail closed.** Do **not** markdown-fall-back. Require planning to be re-run/fixed. |
|
|
121
|
+
| `beads_usable` **and a valid stable-ID contract** | **Resume your own task, materialize, then claim** (see Step 3). |
|
|
122
|
+
|
|
123
|
+
**Step 3 — `beads_usable` + valid contract:**
|
|
124
|
+
|
|
125
|
+
1. **Resume the actor's own in-flight *plan* task first.** Before claiming
|
|
126
|
+
anything new — and using the **stable** claim actor (resolve `BEADS_ACTOR` →
|
|
127
|
+
`git user.name` → `$USER`, never empty) — check for a **plan-derived** task
|
|
128
|
+
already `in_progress` assigned to you, scoped exactly like claiming:
|
|
129
|
+
`bd list --status in_progress --assignee <actor> --has-metadata-key plan_task_id --json`.
|
|
130
|
+
If one exists, continue it (see "Resume In-Progress Work" below). Scoping to
|
|
131
|
+
`plan_task_id` prevents resuming onto an unrelated manual/bootstrap issue
|
|
132
|
+
assigned to the same actor; any such non-plan in-progress work is reported
|
|
133
|
+
separately, not resumed as build work.
|
|
134
|
+
2. **Reconcile merged PRs.** If a PR shows as merged, close the corresponding
|
|
135
|
+
task: `bd close <id>`.
|
|
136
|
+
3. **Always invoke the canonical materializer** before claiming new work:
|
|
137
|
+
`/scaffold:materialize-plan-to-beads`. Run it unconditionally — do **not**
|
|
138
|
+
gate it on a count or ID-set comparison. It is idempotent (a cheap no-op when
|
|
139
|
+
in sync) and is the single source of the four-pass reconcile logic — this
|
|
140
|
+
prompt **invokes** it, it does not duplicate it. If it returns non-zero,
|
|
141
|
+
**fail closed** — stop, surface the error, do **not** claim and do **not**
|
|
142
|
+
markdown-fall-back past existing Beads state.
|
|
143
|
+
4. **Run the scoped claim loop.** Atomically claim the next ready **plan** task:
|
|
144
|
+
`TASK=$(bd ready --claim --has-metadata-key plan_task_id --json | jq -r '.id')`
|
|
145
|
+
- Scoping to `plan_task_id` keeps the loop from ever claiming the bootstrap
|
|
146
|
+
"initialize Beads" bead or a manually-created issue.
|
|
147
|
+
- This sets `assignee=$BEADS_ACTOR` + `status=in_progress` in a single
|
|
148
|
+
round-trip — no race window.
|
|
149
|
+
5. Continue until the scoped claim
|
|
150
|
+
(`bd ready --claim --has-metadata-key plan_task_id --json`) returns no ready
|
|
151
|
+
task, then run the **completion check**.
|
|
152
|
+
|
|
153
|
+
**Completion check (empty `bd ready` ≠ done).** An empty scoped-ready result does
|
|
154
|
+
**not** mean the build is finished. On an empty result, fetch all plan-derived
|
|
155
|
+
tasks (`bd list --all --limit 0 --has-metadata-key plan_task_id --json`) and
|
|
156
|
+
classify the remaining non-`closed` tasks:
|
|
157
|
+
|
|
158
|
+
- **All plan tasks `closed`** → genuinely **done**; exit gracefully.
|
|
159
|
+
- Otherwise classify **each** remaining non-`closed` task independently — do
|
|
160
|
+
**not** short-circuit on "any task is `in_progress`". Resolve blocker statuses
|
|
161
|
+
from an **unfiltered** `bd list --all --limit 0 --json` (manual blockers carry
|
|
162
|
+
no `plan_task_id`):
|
|
163
|
+
- **advancing** — the task is itself `in_progress`, **or** a **transitive**
|
|
164
|
+
blocker (walk the chain; bound the walk, reuse `bd dep cycles`) is
|
|
165
|
+
`in_progress`.
|
|
166
|
+
- **stalled** — not `in_progress` and no transitive blocker is `in_progress`.
|
|
167
|
+
- **All remaining advancing** → exit gracefully. **Any stalled** → **stop and
|
|
168
|
+
report the stalled subset**, grouped by why (open dependency, manual `blocked`,
|
|
169
|
+
`deferred`).
|
|
170
|
+
|
|
171
|
+
**Markdown fallback** (only when `.beads/` is **absent**, or for a genuinely
|
|
172
|
+
legacy plan per the table — never past existing Beads state):
|
|
107
173
|
- Read `docs/implementation-playbook.md` as the primary task reference.
|
|
108
174
|
Fall back to `docs/implementation-plan.md` when no playbook is present.
|
|
109
175
|
- If a PR shows as merged, mark the corresponding task as complete in the plan/playbook
|
|
@@ -98,18 +98,75 @@ Before writing any code, verify the environment is ready:
|
|
|
98
98
|
|
|
99
99
|
### Beads Detection
|
|
100
100
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
**
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
-
|
|
109
|
-
|
|
110
|
-
-
|
|
111
|
-
|
|
112
|
-
|
|
101
|
+
The implementation plan is materialized into Beads issues by
|
|
102
|
+
`/scaffold:materialize-plan-to-beads` before the build phase. This block is the
|
|
103
|
+
**defensive preflight** that guarantees the tracker is populated and current
|
|
104
|
+
before any work is claimed — it never claims against an empty or stale tracker.
|
|
105
|
+
|
|
106
|
+
**Step 1 — compute `beads_usable`.** `beads_usable` is true only when **all**
|
|
107
|
+
hold: `.beads/` exists, `bd` is on `PATH`, `bd version` parses to **≥ 1.0.5**
|
|
108
|
+
(using a macOS/BSD-safe numeric compare — split major/minor/patch and compare
|
|
109
|
+
numerically, never rely on GNU `sort -V`), and `jq` is on `PATH`. Never write
|
|
110
|
+
`[ -d .beads ] && bd …` as a whole command — it returns exit 1 when `.beads/` is
|
|
111
|
+
absent and breaks callers under `set -e`; use an `if`.
|
|
112
|
+
|
|
113
|
+
**Step 2 — route on the decision table** (this is what prevents the "empty
|
|
114
|
+
tracker looks done" bug):
|
|
115
|
+
|
|
116
|
+
| Condition | Action |
|
|
117
|
+
|---|---|
|
|
118
|
+
| `.beads/` **absent** | Non-Beads project → drive the loop from the markdown playbook/plan (see "Markdown fallback" below). Do **not** call `bd`. |
|
|
119
|
+
| `.beads/` present but `beads_usable` is false (`bd`/`jq` missing or `bd` < 1.0.5) | **Fail closed.** Stop and tell the user to install/upgrade `bd` (≥ v1.0.5) and `jq`. Do **not** markdown-fall-back — Beads may already hold execution state, and a markdown re-run would re-execute completed work. |
|
|
120
|
+
| `beads_usable`, but the plan has **no** stable task IDs **and** Beads holds no plan-derived issues and no non-bootstrap claimed/closed work | Genuinely legacy plan → markdown loop, and emit "re-run planning to assign stable task IDs". Do **not** claim. |
|
|
121
|
+
| `beads_usable`, plan has no stable IDs **but** Beads already holds plausible build work (claimed/closed non-bootstrap issues) | **Fail closed** — markdown would bypass existing execution state. Require re-running planning + materialization. |
|
|
122
|
+
| `beads_usable`, contract **partially present or malformed** (some IDs present, or plan-derived issues already exist, but the contract doesn't fully parse) | **Fail closed.** Do **not** markdown-fall-back (would bypass existing plan-derived issues and diverge). Require planning to be re-run/fixed. |
|
|
123
|
+
| `beads_usable` **and a valid stable-ID contract** | **Always materialize first, then claim** (see Step 3). |
|
|
124
|
+
|
|
125
|
+
**Step 3 — `beads_usable` + valid contract → materialize, then claim:**
|
|
126
|
+
|
|
127
|
+
1. **Always invoke the canonical materializer:** `/scaffold:materialize-plan-to-beads`.
|
|
128
|
+
Run it unconditionally — do **not** gate it on a count or ID-set comparison
|
|
129
|
+
(every such gate misses content-only edits, partial imports, or stale deps).
|
|
130
|
+
The materializer is idempotent and a cheap no-op when already in sync; it is
|
|
131
|
+
the single source of the four-pass reconcile logic — this prompt **invokes**
|
|
132
|
+
it, it does not duplicate it. If the materializer returns non-zero (mid-run
|
|
133
|
+
failure), **fail closed** — stop and surface the error; do **not** claim and
|
|
134
|
+
do **not** markdown-fall-back past existing Beads state.
|
|
135
|
+
2. **Run the scoped claim loop.** Atomically claim the next ready **plan** task:
|
|
136
|
+
`TASK=$(bd ready --claim --has-metadata-key plan_task_id --json | jq -r '.id')`
|
|
137
|
+
- Scoping to `plan_task_id` keeps the loop from ever claiming the bootstrap
|
|
138
|
+
"initialize Beads" bead or a manually-created issue.
|
|
139
|
+
- This sets `assignee=$BEADS_ACTOR` (or your git user.name) and
|
|
140
|
+
`status=in_progress` in a single round-trip — no race window.
|
|
141
|
+
- If you need a specific task by ID instead, use `bd update <id> --claim`.
|
|
142
|
+
3. Implement following the TDD workflow below.
|
|
143
|
+
4. After the PR is merged, run `bd close <id>`.
|
|
144
|
+
5. Repeat the scoped claim (`bd ready --claim --has-metadata-key plan_task_id --json`)
|
|
145
|
+
until it returns no ready task, then run the **completion check**.
|
|
146
|
+
|
|
147
|
+
**Completion check (empty `bd ready` ≠ done).** An empty scoped-ready result does
|
|
148
|
+
**not** mean the build is finished — every remaining task could be blocked. On an
|
|
149
|
+
empty result, fetch all plan-derived tasks
|
|
150
|
+
(`bd list --all --limit 0 --has-metadata-key plan_task_id --json`) and classify
|
|
151
|
+
the remaining non-`closed` tasks:
|
|
152
|
+
|
|
153
|
+
- **All plan tasks `closed`** → genuinely **done**; exit gracefully.
|
|
154
|
+
- Otherwise classify **each** remaining non-`closed` task independently — do
|
|
155
|
+
**not** short-circuit on "any task is `in_progress`". Resolve blocker statuses
|
|
156
|
+
from an **unfiltered** `bd list --all --limit 0 --json` (manual blockers carry
|
|
157
|
+
no `plan_task_id`):
|
|
158
|
+
- **advancing** — the task is itself `in_progress`, **or** at least one of its
|
|
159
|
+
**transitive** blockers (walk the chain; bound the walk and reuse
|
|
160
|
+
`bd dep cycles` as a guard) is `in_progress`.
|
|
161
|
+
- **stalled** — not `in_progress` and **no** transitive blocker is
|
|
162
|
+
`in_progress` (open-but-unready behind inactive blockers, manually `blocked`,
|
|
163
|
+
or `deferred`).
|
|
164
|
+
- **All remaining tasks advancing** → exit gracefully.
|
|
165
|
+
- **Any task stalled** → **stop and report the stalled subset**, grouped by why
|
|
166
|
+
(open dependency, manual `blocked`, `deferred`), so the user can unblock them.
|
|
167
|
+
|
|
168
|
+
**Markdown fallback** (only when `.beads/` is **absent**, or for a genuinely
|
|
169
|
+
legacy plan per the table — never past existing Beads state):
|
|
113
170
|
1. Read `docs/implementation-playbook.md` as the primary task execution reference.
|
|
114
171
|
Fall back to `docs/implementation-plan.md` when no playbook is present.
|
|
115
172
|
2. Pick the first uncompleted task that has no unfinished dependencies.
|