feat(#3227): publish machine-readable state contract at step boundaries (#3824)

* feat(#3227): publish machine-readable state contract at step boundaries

Adds src/state-contract.cts, a best-effort publisher that writes
.planning/state.json (contract 1.0.0) at 11 step-boundary commands, so
external tools read a versioned contract instead of parsing STATE.md and
ROADMAP.md heuristically.

Composes existing owners rather than re-deriving: phase rows come from a
new locateProgressTable extracted from deriveProgressFromRoadmap (so the
snapshot can never disagree with GSD's own progress counters), milestone
identity from getMilestoneInfo, and next from classifyProject. Owners are
required lazily to avoid the state -> state-contract -> smart-entry ->
state require cycle.

Also fixes a pre-existing defect in scripts/lint-test-file-count.cjs
(maintainer-approved as a second concern): testEffectivePrefix never
stripped the suite qualifier, so 65 dotted test files counted against no
module and 9 mis-bucketed into a shorter one. Allowlist re-baselined for
the 74 files the gate can now see.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(#3227): backfill PR number into the changeset fragment

pr:0 -> pr:3824 now that the PR exists. Doc-only.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#3227): shape hostile-name fixtures away from the scan corpus

The two hostile-input fixtures used a literal phrase from
scripts/prompt-injection-scan.sh's corpus, so CI's Security Scan redded on
this file. These tests assert that an arbitrary phase name round-trips into
state.json as inert data -- the property holds for any string, so the
injection flavor is illustrative, not load-bearing.

Reshaped to a hyphenated fake instruction tag, which stays hostile-looking
while matching none of the scanner's patterns. Allowlisting the file was
rejected: that mechanism is for suites whose subject IS injection defense,
and it would blind the scanner to this whole file permanently.
See DEFECT.PROMPT-INJECTION-SCAN-COLLISION.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* chore(#3227): ratchet the state-contract mutation floor to its measured score

The module was registered at minScore 50, the ratchet's minimum permitted
floor for a newly-registered module whose score had not been measured. This
PR's own Stryker shard measured 66.25% (run 32769289750, job 97565813640),
so the floor moves to floor(measured) - 1 = 65, per the rule the registry
documents.

66.25 is below TARGET_MUTATION_SCORE (80), so this stays a ratchet
candidate: raise as the tests improve, never lower.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: sim <sim@local>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
2026-08-24 17:56:02 -04:00
committed by GitHub
parent fb9823e1e1
commit 596540f864
23 changed files with 2739 additions and 25 deletions

View File

@@ -23,7 +23,7 @@ describe('CANONICAL_EXACT', () => {
const expected = [
'PROJECT.md', 'ROADMAP.md', 'STATE.md', 'REQUIREMENTS.md',
'MILESTONES.md', 'BACKLOG.md', 'LEARNINGS.md', 'THREADS.md',
'config.json', 'CLAUDE.md', 'RETROSPECTIVE.md', 'WINDOWS.md',
'config.json', 'CLAUDE.md', 'RETROSPECTIVE.md', 'WINDOWS.md', 'state.json',
];
for (const name of expected) {
assert.ok(CANONICAL_EXACT.has(name), `expected ${name} in CANONICAL_EXACT`);
@@ -58,6 +58,15 @@ describe('isCanonicalPlanningFile', () => {
assert.strictEqual(isCanonicalPlanningFile('config.json'), true);
});
test('#3227: state.json (machine-readable state contract) is a canonical .planning/ artifact', () => {
// gsd-core writes .planning/state.json at every step boundary
// (src/state-contract.cts). Before #3227 it was absent from the
// registry, so validate health would falsely flag it W019
// "Unrecognized" on every GSD project.
assert.ok(CANONICAL_EXACT.has('state.json'), 'state.json must be in CANONICAL_EXACT');
assert.strictEqual(isCanonicalPlanningFile('state.json'), true);
});
test('#3224: WINDOWS.md (broken-windows ledger) is a canonical .planning/ artifact', () => {
// gsd-core itself writes .planning/WINDOWS.md (src/broken-windows.cts,
// LEDGER_FILE_NAME = 'WINDOWS.md'). Before #3224 it was absent from the
@@ -188,6 +197,18 @@ describe('gsd-health W019 — unrecognized .planning/ root files', () => {
assert.strictEqual(w019, undefined, 'no W019 for canonical files');
});
test('#3227: no W019 for .planning/state.json (state contract published at step boundaries)', () => {
const dir = makeTempProject({
...BASE_FILES,
'.planning/state.json': '{}',
});
const result = cmdValidateHealth(dir, { repair: false }, false);
const w019 = result.warnings.find(w => w.code === 'W019');
assert.strictEqual(w019, undefined, 'state.json must not be flagged as unrecognized');
});
test('no W019 for phase subdirectory files (only root is checked)', () => {
const dir = makeTempProject({
...BASE_FILES,