@sdd-method/maintain-cli 0.3.0 → 0.5.0
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/dist/lib/briefing/render.js +1 -2
- package/dist/lib/briefing/variables.js +1 -2
- package/dist/lib/catalogue/aggregate.js +35 -36
- package/dist/lib/catalogue/application-archetype/expectations.js +1 -1
- package/dist/lib/catalogue/archetype/wireframe.js +1 -1
- package/dist/lib/catalogue/build.js +17 -23
- package/dist/lib/catalogue/builders/application-conformance-coverage.js +1 -1
- package/dist/lib/catalogue/builders/c4-components.js +4 -5
- package/dist/lib/catalogue/builders/c4-containers.js +3 -3
- package/dist/lib/catalogue/builders/c4-entity-rollups.js +1 -1
- package/dist/lib/catalogue/builders/c4-external-systems.js +1 -1
- package/dist/lib/catalogue/builders/c4-l1-candidates.js +1 -1
- package/dist/lib/catalogue/builders/capabilities.js +2 -2
- package/dist/lib/catalogue/builders/capability-edges.js +4 -4
- package/dist/lib/catalogue/builders/capability-spec-walker.js +3 -3
- package/dist/lib/catalogue/builders/container-dependency.js +18 -19
- package/dist/lib/catalogue/builders/contracts.js +5 -6
- package/dist/lib/catalogue/builders/data-store-mapping.js +3 -3
- package/dist/lib/catalogue/builders/edge-label-merge.js +2 -2
- package/dist/lib/catalogue/builders/entities-manifest.js +1 -1
- package/dist/lib/catalogue/builders/entities-mermaid.js +3 -3
- package/dist/lib/catalogue/builders/entity-slug.js +11 -12
- package/dist/lib/catalogue/builders/event-catalog-walker.js +3 -3
- package/dist/lib/catalogue/builders/event-edges.js +1 -1
- package/dist/lib/catalogue/builders/evidence-class.js +2 -2
- package/dist/lib/catalogue/builders/external-system-exemption.js +1 -1
- package/dist/lib/catalogue/builders/feature-contract.js +1 -3
- package/dist/lib/catalogue/builders/feature-grounding.js +1 -2
- package/dist/lib/catalogue/builders/feature-groups.js +0 -1
- package/dist/lib/catalogue/builders/feature-subscription-channels.js +2 -3
- package/dist/lib/catalogue/builders/feature-tree-walker.js +1 -1
- package/dist/lib/catalogue/builders/features.js +3 -4
- package/dist/lib/catalogue/builders/glossary-xref.js +1 -1
- package/dist/lib/catalogue/builders/persona-c4system.js +7 -7
- package/dist/lib/catalogue/builders/persona-container.js +14 -14
- package/dist/lib/catalogue/builders/personas.js +1 -2
- package/dist/lib/catalogue/builders/product-platform-dependencies.js +2 -2
- package/dist/lib/catalogue/builders/quality-scores.js +1 -1
- package/dist/lib/catalogue/builders/repositories.js +2 -2
- package/dist/lib/catalogue/builders/screen-tree.js +1 -1
- package/dist/lib/catalogue/builders/screens.js +3 -4
- package/dist/lib/catalogue/builders/system-external-dependency.js +7 -7
- package/dist/lib/catalogue/canonical-schema.yaml +23 -23
- package/dist/lib/catalogue/contract-path-resolution.js +3 -3
- package/dist/lib/catalogue/coverage-predicates.js +4 -4
- package/dist/lib/catalogue/coverage-run.js +1 -1
- package/dist/lib/catalogue/dedupe-keyed-tables.js +2 -3
- package/dist/lib/catalogue/ext-id.js +4 -4
- package/dist/lib/catalogue/feature-grounding-aliases-loader.js +1 -1
- package/dist/lib/catalogue/finding-identity.js +3 -3
- package/dist/lib/catalogue/freshness.js +1 -1
- package/dist/lib/catalogue/manifest-loader.js +2 -2
- package/dist/lib/catalogue/scaffold-delta.js +1 -1
- package/dist/lib/catalogue/schema-compat.js +1 -2
- package/dist/lib/catalogue/screen-validation-loader.js +1 -1
- package/dist/lib/catalogue/staleness-verdicts.js +2 -2
- package/dist/lib/catalogue/traceability-loader.js +2 -3
- package/dist/lib/ci-binding/index.js +108 -33
- package/dist/lib/ci-binding/module.js +18 -8
- package/dist/lib/init/ci-workflow.js +2 -0
- package/dist/lib/lock-file.js +1 -1
- package/dist/lib/pack/reference-closure.js +3 -3
- package/dist/lib/package-version.js +1 -1
- package/dist/lib/snapshot/manifest.js +1 -1
- package/dist/lib/sync/adr-transitions.js +1 -1
- package/dist/lib/sync/config.js +8 -1
- package/dist/lib/sync/diff.js +1 -1
- package/dist/lib/sync/index.js +8 -3
- package/dist/lib/validate/behaviour-store.js +351 -0
- package/dist/lib/validate/dispatch.js +18 -0
- package/dist/lib/validate/index.js +1 -1
- package/dist/lib/validate/plan.js +3 -1
- package/dist/lib/validate/yaml-parse.js +1 -1
- package/dist/maintain-version.json +2 -2
- package/dist/verbs/sync.js +1 -1
- package/dist/verify-version.json +2 -2
- package/package.json +4 -6
- package/scripts/validate-app-dependencies.sh +5 -5
- package/scripts/validate-integration-docs.sh +1 -1
- package/LICENSE +0 -201
- package/NOTICE +0 -17
|
@@ -0,0 +1,351 @@
|
|
|
1
|
+
// Behaviour-store checks (M-ADR 0221, 0222, 0223): the gates OpenSpec itself does not enforce.
|
|
2
|
+
//
|
|
3
|
+
// An SDD's behaviour store is an OpenSpec project; in the inside-SDD shape it is `openspec/` at the
|
|
4
|
+
// SDD root, with one agreement record per change at `docs/agreements/<change>.yaml`
|
|
5
|
+
// (agreement-record-schema.yaml). OpenSpec checks the format of specs and deltas. It does not check
|
|
6
|
+
// that a change was agreed before it was built, that the requirements it modifies stayed as they
|
|
7
|
+
// were agreed, or that an archived change was judged. These are those checks:
|
|
8
|
+
//
|
|
9
|
+
// 1. records: every agreement record has the shape the checks below read.
|
|
10
|
+
// 2. agreement: an open change with any completed task has an agreed record and a Gate 0 that
|
|
11
|
+
// ends CLEAR (the pre-apply check, M-ADR 0223 §4.3).
|
|
12
|
+
// 3. stale: for each open, agreed change that MODIFIES, REMOVES or RENAMES requirements, the
|
|
13
|
+
// targeted living specs are unchanged since the agreed commit (M-ADR 0223 §4.5).
|
|
14
|
+
// With no such targets the check is vacuous, and says so.
|
|
15
|
+
// 4. verdicts: every archived change except a baseline has a verdict.md and a record whose
|
|
16
|
+
// verdict is PASS and names it (M-ADR 0223 §4.6).
|
|
17
|
+
//
|
|
18
|
+
// A sibling-repository store (M-ADR 0221 §4.2) is checked in that repository, not here.
|
|
19
|
+
//
|
|
20
|
+
// OPENSPEC'S OWN VALIDATION is the separate validator `behaviour-store-openspec`, because it needs
|
|
21
|
+
// the OpenSpec CLI at OPENSPEC_VERSION (the Method Validation module installs it). Without a store
|
|
22
|
+
// both report [N/A], an empty population, never a pass.
|
|
23
|
+
import { execFile } from "node:child_process";
|
|
24
|
+
import { access, readdir, readFile } from "node:fs/promises";
|
|
25
|
+
import { basename, join } from "node:path";
|
|
26
|
+
import { promisify } from "node:util";
|
|
27
|
+
import { parseDocument } from "yaml";
|
|
28
|
+
const execFileAsync = promisify(execFile);
|
|
29
|
+
/** The OpenSpec release the method depends on (M-ADR 0223 ruling 2). The module installs exactly this. */
|
|
30
|
+
export const OPENSPEC_VERSION = "1.14.3";
|
|
31
|
+
/** Telemetry off for every OpenSpec run the method makes. */
|
|
32
|
+
export const OPENSPEC_ENV = { OPENSPEC_TELEMETRY: "0", DO_NOT_TRACK: "1" };
|
|
33
|
+
export const STORE_DIR = "openspec";
|
|
34
|
+
export const AGREEMENTS_DIR = "docs/agreements";
|
|
35
|
+
const AGREEMENT_STATUSES = ["proposed", "agreed", "superseded", "withdrawn"];
|
|
36
|
+
const COMMIT_RE = /^[0-9a-f]{7,40}$/;
|
|
37
|
+
// OpenSpec counts a task done when its box holds only `x`, either case, any spacing.
|
|
38
|
+
const TASK_DONE_RE = /^\s*-\s*\[\s*[xX]\s*\]/m;
|
|
39
|
+
const TARGET_HEADING_RE = /^##\s+(MODIFIED|REMOVED|RENAMED)\s+Requirements\b/m;
|
|
40
|
+
async function exists(p) {
|
|
41
|
+
try {
|
|
42
|
+
await access(p);
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
catch {
|
|
46
|
+
return false;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
async function dirs(p) {
|
|
50
|
+
try {
|
|
51
|
+
return (await readdir(p, { withFileTypes: true })).filter((d) => d.isDirectory()).map((d) => d.name).sort();
|
|
52
|
+
}
|
|
53
|
+
catch {
|
|
54
|
+
return [];
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
async function readText(p) {
|
|
58
|
+
try {
|
|
59
|
+
return await readFile(p, "utf8");
|
|
60
|
+
}
|
|
61
|
+
catch {
|
|
62
|
+
return null;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
/** Read and shape-check one agreement record. Returns the record, or the problems found. */
|
|
66
|
+
export function parseAgreementRecord(file, text) {
|
|
67
|
+
const problems = [];
|
|
68
|
+
const doc = parseDocument(text);
|
|
69
|
+
if (doc.errors.length > 0) {
|
|
70
|
+
return { problems: doc.errors.map((e) => `${file}: does not parse: ${e.message.split("\n")[0]}`) };
|
|
71
|
+
}
|
|
72
|
+
const root = doc.toJS();
|
|
73
|
+
const r = root?.agreement_record;
|
|
74
|
+
if (!r || typeof r !== "object")
|
|
75
|
+
return { problems: [`${file}: no top-level agreement_record`] };
|
|
76
|
+
const expected = basename(file).replace(/\.ya?ml$/, "");
|
|
77
|
+
if (r.change !== expected)
|
|
78
|
+
problems.push(`${file}: change is ${JSON.stringify(r.change)}, expected "${expected}" (the file name)`);
|
|
79
|
+
const status = typeof r.status === "string" ? r.status : "";
|
|
80
|
+
if (!AGREEMENT_STATUSES.includes(status)) {
|
|
81
|
+
problems.push(`${file}: status ${JSON.stringify(r.status)} is not one of ${AGREEMENT_STATUSES.join(" | ")}`);
|
|
82
|
+
}
|
|
83
|
+
const sdd = (r.sdd ?? {});
|
|
84
|
+
const gates = Array.isArray(r.gates) ? r.gates : [];
|
|
85
|
+
const gate0 = gates.find((g) => g && g.name === "gate-0");
|
|
86
|
+
if (status === "agreed") {
|
|
87
|
+
if (r.agreed_on === undefined || r.agreed_on === null)
|
|
88
|
+
problems.push(`${file}: agreed, but no agreed_on`);
|
|
89
|
+
if (typeof r.approved_by !== "string" || r.approved_by.trim() === "")
|
|
90
|
+
problems.push(`${file}: agreed, but no approved_by`);
|
|
91
|
+
if (typeof sdd.commit !== "string") {
|
|
92
|
+
problems.push(`${file}: sdd.commit must be a quoted string, found ${sdd.commit === undefined ? "nothing" : `${typeof sdd.commit} ${String(sdd.commit)}`}` +
|
|
93
|
+
(typeof sdd.commit === "number" ? " (unquoted, YAML parsed the SHA as a number)" : ""));
|
|
94
|
+
}
|
|
95
|
+
else if (!COMMIT_RE.test(sdd.commit)) {
|
|
96
|
+
problems.push(`${file}: sdd.commit "${sdd.commit}" is not 7-40 hex characters`);
|
|
97
|
+
}
|
|
98
|
+
if (!gate0)
|
|
99
|
+
problems.push(`${file}: agreed, but no gates entry named gate-0`);
|
|
100
|
+
else if (gate0.result !== "CLEAR")
|
|
101
|
+
problems.push(`${file}: agreed, but gate-0 result is ${JSON.stringify(gate0.result)}, not CLEAR`);
|
|
102
|
+
}
|
|
103
|
+
// Every commit a record pins must survive parsing as a string. YAML 1.2 reads an unquoted
|
|
104
|
+
// all-digit abbreviation as an integer and one shaped like `1234e567` or `123e456` as a float
|
|
105
|
+
// (Infinity), and the pin is then lost; checking the PARSED type is the only test that catches
|
|
106
|
+
// both, since a pattern applied after coercion sees "Infinity" or a number.
|
|
107
|
+
for (const [path, value] of commitFields(r)) {
|
|
108
|
+
if (path === "sdd.commit")
|
|
109
|
+
continue;
|
|
110
|
+
if (typeof value !== "string") {
|
|
111
|
+
problems.push(`${file}: ${path} must be a quoted string, found ${typeof value} ${String(value)} (unquoted, YAML parsed the SHA as a number)`);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
const verdict = r.verdict && typeof r.verdict === "object" ? r.verdict : undefined;
|
|
115
|
+
if (problems.length > 0)
|
|
116
|
+
return { problems };
|
|
117
|
+
return {
|
|
118
|
+
record: {
|
|
119
|
+
file,
|
|
120
|
+
change: expected,
|
|
121
|
+
status,
|
|
122
|
+
...(typeof sdd.commit === "string" ? { commit: sdd.commit } : {}),
|
|
123
|
+
...(typeof gate0?.result === "string" ? { gate0: gate0.result } : {}),
|
|
124
|
+
...(verdict ? { verdict } : {}),
|
|
125
|
+
},
|
|
126
|
+
problems,
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
/** Every pinned commit in a record: any key named `commit` or ending `_commit`, and each value under verdict.merged and current. */
|
|
130
|
+
function commitFields(r) {
|
|
131
|
+
const out = [];
|
|
132
|
+
const walk = (v, path, pinMap) => {
|
|
133
|
+
if (Array.isArray(v))
|
|
134
|
+
v.forEach((x, i) => walk(x, `${path}[${i}]`, false));
|
|
135
|
+
else if (v && typeof v === "object") {
|
|
136
|
+
for (const [k, x] of Object.entries(v)) {
|
|
137
|
+
const p = path === "" ? k : `${path}.${k}`;
|
|
138
|
+
const isPin = pinMap || k === "commit" || k.endsWith("_commit");
|
|
139
|
+
if (isPin && (x === null || typeof x !== "object"))
|
|
140
|
+
out.push([p, x]);
|
|
141
|
+
else
|
|
142
|
+
walk(x, p, p === "verdict.merged" || p === "current");
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
};
|
|
146
|
+
walk(r, "", false);
|
|
147
|
+
return out;
|
|
148
|
+
}
|
|
149
|
+
function lastGateLine(text) {
|
|
150
|
+
const lines = text.split("\n").map((l) => l.trim()).filter((l) => l !== "");
|
|
151
|
+
return lines.at(-1) ?? "";
|
|
152
|
+
}
|
|
153
|
+
async function gitDiffQuiet(repo, commit, path) {
|
|
154
|
+
try {
|
|
155
|
+
await execFileAsync("git", ["-C", repo, "cat-file", "-e", `${commit}^{commit}`]);
|
|
156
|
+
}
|
|
157
|
+
catch {
|
|
158
|
+
return "unresolved";
|
|
159
|
+
}
|
|
160
|
+
try {
|
|
161
|
+
await execFileAsync("git", ["-C", repo, "diff", "--quiet", commit, "HEAD", "--", path]);
|
|
162
|
+
return "same";
|
|
163
|
+
}
|
|
164
|
+
catch (err) {
|
|
165
|
+
return err.code === 1 ? "changed" : "unresolved";
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
/** The living specs an open change's deltas modify, remove or rename: openspec/specs/<capability>/spec.md. */
|
|
169
|
+
async function targetedSpecs(repo, changeDir) {
|
|
170
|
+
const out = [];
|
|
171
|
+
const walk = async (rel) => {
|
|
172
|
+
const abs = join(repo, changeDir, "specs", rel);
|
|
173
|
+
let entries;
|
|
174
|
+
try {
|
|
175
|
+
entries = await readdir(abs, { withFileTypes: true });
|
|
176
|
+
}
|
|
177
|
+
catch {
|
|
178
|
+
return;
|
|
179
|
+
}
|
|
180
|
+
for (const e of entries) {
|
|
181
|
+
const childRel = rel === "" ? e.name : `${rel}/${e.name}`;
|
|
182
|
+
if (e.isDirectory())
|
|
183
|
+
await walk(childRel);
|
|
184
|
+
else if (e.name === "spec.md") {
|
|
185
|
+
const text = (await readText(join(abs, e.name))) ?? "";
|
|
186
|
+
if (TARGET_HEADING_RE.test(text))
|
|
187
|
+
out.push(`${STORE_DIR}/specs/${rel}/spec.md`);
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
};
|
|
191
|
+
await walk("");
|
|
192
|
+
return out.sort();
|
|
193
|
+
}
|
|
194
|
+
export async function checkBehaviourStore(repo) {
|
|
195
|
+
if (!(await exists(join(repo, STORE_DIR)))) {
|
|
196
|
+
return { exitCode: 0, stdout: `[N/A] no behaviour store (${STORE_DIR}/) in this repository\n` };
|
|
197
|
+
}
|
|
198
|
+
const lines = [];
|
|
199
|
+
const failures = [];
|
|
200
|
+
// 1. records
|
|
201
|
+
const records = new Map();
|
|
202
|
+
let recordFiles = [];
|
|
203
|
+
try {
|
|
204
|
+
recordFiles = (await readdir(join(repo, AGREEMENTS_DIR))).filter((f) => /\.ya?ml$/.test(f)).sort();
|
|
205
|
+
}
|
|
206
|
+
catch {
|
|
207
|
+
recordFiles = [];
|
|
208
|
+
}
|
|
209
|
+
for (const f of recordFiles) {
|
|
210
|
+
const rel = `${AGREEMENTS_DIR}/${f}`;
|
|
211
|
+
const { record, problems } = parseAgreementRecord(rel, (await readText(join(repo, rel))) ?? "");
|
|
212
|
+
failures.push(...problems);
|
|
213
|
+
if (record)
|
|
214
|
+
records.set(record.change, record);
|
|
215
|
+
}
|
|
216
|
+
lines.push(`records: ${recordFiles.length} agreement record(s), ${recordFiles.length - records.size} malformed`);
|
|
217
|
+
// 2 and 3. open changes
|
|
218
|
+
const open = (await dirs(join(repo, STORE_DIR, "changes"))).filter((d) => d !== "archive");
|
|
219
|
+
let started = 0;
|
|
220
|
+
let staleChecked = 0;
|
|
221
|
+
for (const change of open) {
|
|
222
|
+
const dir = `${STORE_DIR}/changes/${change}`;
|
|
223
|
+
const tasks = await readText(join(repo, dir, "tasks.md"));
|
|
224
|
+
const record = records.get(change);
|
|
225
|
+
if (tasks !== null && TASK_DONE_RE.test(tasks)) {
|
|
226
|
+
started++;
|
|
227
|
+
if (!record)
|
|
228
|
+
failures.push(`${dir}: has completed tasks but no agreement record (${AGREEMENTS_DIR}/${change}.yaml)`);
|
|
229
|
+
else if (record.status !== "agreed")
|
|
230
|
+
failures.push(`${dir}: has completed tasks but its agreement record is ${record.status}, not agreed`);
|
|
231
|
+
const gate = await readText(join(repo, dir, "gate-0.md"));
|
|
232
|
+
if (gate === null)
|
|
233
|
+
failures.push(`${dir}: has completed tasks but no gate-0.md`);
|
|
234
|
+
else if (lastGateLine(gate) !== "GATE: CLEAR")
|
|
235
|
+
failures.push(`${dir}: has completed tasks but gate-0.md ends "${lastGateLine(gate)}", not "GATE: CLEAR"`);
|
|
236
|
+
}
|
|
237
|
+
if (record?.status === "agreed" && record.commit) {
|
|
238
|
+
for (const spec of await targetedSpecs(repo, dir)) {
|
|
239
|
+
staleChecked++;
|
|
240
|
+
const r = await gitDiffQuiet(repo, record.commit, spec);
|
|
241
|
+
if (r === "changed")
|
|
242
|
+
failures.push(`${dir}: STALE: ${spec} changed since the agreed commit ${record.commit}`);
|
|
243
|
+
if (r === "unresolved")
|
|
244
|
+
failures.push(`${dir}: stale check unresolved: commit ${record.commit} is not in this clone's history (a shallow clone cannot run it)`);
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
lines.push(`agreement: ${open.length} open change(s), ${started} with completed tasks`);
|
|
249
|
+
lines.push(staleChecked === 0 ? "stale: vacuous (no open agreed change modifies, removes or renames a requirement)" : `stale: ${staleChecked} targeted living spec(s) checked against their agreed commits`);
|
|
250
|
+
// 4. archived changes
|
|
251
|
+
const archived = await dirs(join(repo, STORE_DIR, "changes", "archive"));
|
|
252
|
+
let baselines = 0;
|
|
253
|
+
for (const name of archived) {
|
|
254
|
+
const dir = `${STORE_DIR}/changes/archive/${name}`;
|
|
255
|
+
if (await exists(join(repo, dir, "baseline-evidence.md"))) {
|
|
256
|
+
baselines++;
|
|
257
|
+
continue;
|
|
258
|
+
}
|
|
259
|
+
const change = name.replace(/^\d{4}-\d{2}-\d{2}-/, "");
|
|
260
|
+
if (!(await exists(join(repo, dir, "verdict.md"))))
|
|
261
|
+
failures.push(`${dir}: archived without verdict.md`);
|
|
262
|
+
const record = records.get(change);
|
|
263
|
+
if (!record) {
|
|
264
|
+
failures.push(`${dir}: archived without an agreement record (${AGREEMENTS_DIR}/${change}.yaml)`);
|
|
265
|
+
continue;
|
|
266
|
+
}
|
|
267
|
+
if (record.verdict?.result !== "PASS")
|
|
268
|
+
failures.push(`${record.file}: change is archived but verdict.result is ${JSON.stringify(record.verdict?.result)}, not PASS`);
|
|
269
|
+
const vr = record.verdict?.record;
|
|
270
|
+
if (typeof vr !== "string" || !(await exists(join(repo, vr))))
|
|
271
|
+
failures.push(`${record.file}: verdict.record ${JSON.stringify(vr)} does not name an existing file`);
|
|
272
|
+
}
|
|
273
|
+
lines.push(`verdicts: ${archived.length} archived change(s), ${baselines} baseline(s), ${archived.length - baselines} needing a PASS verdict`);
|
|
274
|
+
const population = recordFiles.length + open.length + archived.length;
|
|
275
|
+
const body = lines.map((l) => ` ${l}`).join("\n") + "\n";
|
|
276
|
+
if (failures.length > 0) {
|
|
277
|
+
return { exitCode: 1, stdout: body + failures.map((f) => `[FAIL] ${f}`).join("\n") + "\n" };
|
|
278
|
+
}
|
|
279
|
+
if (population === 0)
|
|
280
|
+
return { exitCode: 0, stdout: body + `[N/A] the behaviour store has no changes and no agreement records yet\n` };
|
|
281
|
+
return { exitCode: 0, stdout: body + "[PASS] behaviour store: records, agreement, stale and verdict checks hold\n" };
|
|
282
|
+
}
|
|
283
|
+
async function runOpenspec(repo, args) {
|
|
284
|
+
try {
|
|
285
|
+
const { stdout } = await execFileAsync("openspec", args, { cwd: repo, env: { ...process.env, ...OPENSPEC_ENV }, maxBuffer: 16 * 1024 * 1024 });
|
|
286
|
+
return { code: 0, json: JSON.parse(stdout), raw: stdout };
|
|
287
|
+
}
|
|
288
|
+
catch (err) {
|
|
289
|
+
const e = err;
|
|
290
|
+
let json;
|
|
291
|
+
try {
|
|
292
|
+
json = JSON.parse(e.stdout ?? "");
|
|
293
|
+
}
|
|
294
|
+
catch {
|
|
295
|
+
json = undefined;
|
|
296
|
+
}
|
|
297
|
+
return { code: typeof e.code === "number" ? e.code : 127, ...(json ? { json } : {}), raw: (e.stdout ?? "") + (e.stderr ?? "") };
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
/** OpenSpec's own strict validation of the store: specs and open changes, and archived changes' tasks. */
|
|
301
|
+
export async function checkBehaviourStoreOpenspec(repo) {
|
|
302
|
+
if (!(await exists(join(repo, STORE_DIR)))) {
|
|
303
|
+
return { exitCode: 0, stdout: `[N/A] no behaviour store (${STORE_DIR}/) in this repository\n` };
|
|
304
|
+
}
|
|
305
|
+
let version = "";
|
|
306
|
+
try {
|
|
307
|
+
version = (await execFileAsync("openspec", ["--version"], { env: { ...process.env, ...OPENSPEC_ENV } })).stdout.trim();
|
|
308
|
+
}
|
|
309
|
+
catch {
|
|
310
|
+
return {
|
|
311
|
+
exitCode: 1,
|
|
312
|
+
stdout: `[FAIL] the OpenSpec CLI is not on PATH; this repository has a behaviour store, so its validation cannot run (install @fission-ai/openspec@${OPENSPEC_VERSION}; the Method Validation module does)\n`,
|
|
313
|
+
};
|
|
314
|
+
}
|
|
315
|
+
if (version !== OPENSPEC_VERSION) {
|
|
316
|
+
return { exitCode: 1, stdout: `[FAIL] OpenSpec ${version} is installed; the method depends on exactly ${OPENSPEC_VERSION}\n` };
|
|
317
|
+
}
|
|
318
|
+
const lines = [];
|
|
319
|
+
const failures = [];
|
|
320
|
+
let measured = 0;
|
|
321
|
+
for (const [label, args] of [
|
|
322
|
+
["specs and open changes (--all --strict)", ["validate", "--all", "--strict", "--json", "--no-interactive"]],
|
|
323
|
+
["archived changes' tasks (--archived)", ["validate", "--archived", "--json", "--no-interactive"]],
|
|
324
|
+
]) {
|
|
325
|
+
const r = await runOpenspec(repo, [...args]);
|
|
326
|
+
const t = r.json?.summary?.totals;
|
|
327
|
+
if (!t) {
|
|
328
|
+
failures.push(`${label}: OpenSpec returned no report (exit ${r.code}): ${r.raw.trim().split("\n").slice(-3).join(" | ")}`);
|
|
329
|
+
continue;
|
|
330
|
+
}
|
|
331
|
+
measured += t.items ?? 0;
|
|
332
|
+
lines.push(`${label}: ${t.items ?? 0} item(s), ${t.passed ?? 0} passed, ${t.failed ?? 0} failed`);
|
|
333
|
+
for (const item of r.json?.items ?? []) {
|
|
334
|
+
if (item.valid)
|
|
335
|
+
continue;
|
|
336
|
+
for (const i of item.issues ?? [])
|
|
337
|
+
failures.push(`${label}: ${item.id}${i.path ? ` (${i.path})` : ""}: ${i.level} ${i.message}`);
|
|
338
|
+
if ((item.issues ?? []).length === 0)
|
|
339
|
+
failures.push(`${label}: ${item.id}: invalid`);
|
|
340
|
+
}
|
|
341
|
+
if (r.code !== 0 && (t.failed ?? 0) === 0)
|
|
342
|
+
failures.push(`${label}: OpenSpec exited ${r.code} with no failed item reported`);
|
|
343
|
+
}
|
|
344
|
+
const body = [` OpenSpec ${version}`, ...lines.map((l) => ` ${l}`)].join("\n") + "\n";
|
|
345
|
+
if (failures.length > 0)
|
|
346
|
+
return { exitCode: 1, stdout: body + failures.map((f) => `[FAIL] ${f}`).join("\n") + "\n" };
|
|
347
|
+
if (measured === 0)
|
|
348
|
+
return { exitCode: 0, stdout: body + "[N/A] OpenSpec found no specs and no changes to validate\n" };
|
|
349
|
+
return { exitCode: 0, stdout: body + "[PASS] OpenSpec strict validation holds\n" };
|
|
350
|
+
}
|
|
351
|
+
//# sourceMappingURL=behaviour-store.js.map
|
|
@@ -1,5 +1,20 @@
|
|
|
1
|
+
import { checkBehaviourStore, checkBehaviourStoreOpenspec } from "./behaviour-store.js";
|
|
1
2
|
import { checkBundleCoherence } from "./bundle-coherence.js";
|
|
2
3
|
import { checkYamlParse } from "./yaml-parse.js";
|
|
4
|
+
// The behaviour store (M-ADR 0221-0223) can sit in an SDD of any profile, so every profile carries
|
|
5
|
+
// its two checks; without a store both report [N/A], an empty population, not a pass.
|
|
6
|
+
const BEHAVIOUR_STORE_VALIDATORS = [
|
|
7
|
+
{
|
|
8
|
+
name: "behaviour-store",
|
|
9
|
+
source: { kind: "native", run: async (ctx) => checkBehaviourStore(ctx.targetRepo) },
|
|
10
|
+
build: () => ({ status: "run", args: [] }),
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
name: "behaviour-store-openspec",
|
|
14
|
+
source: { kind: "native", run: async (ctx) => checkBehaviourStoreOpenspec(ctx.targetRepo) },
|
|
15
|
+
build: () => ({ status: "run", args: [] }),
|
|
16
|
+
},
|
|
17
|
+
];
|
|
3
18
|
// Validators that accept --app-root / --repo-root flags work fine from the
|
|
4
19
|
// bundled location because they override their internal ROOT_DIR via the
|
|
5
20
|
// flag. Validators without that flag (adr-structure, runway-classification,
|
|
@@ -74,6 +89,7 @@ const APP_VALIDATORS = [
|
|
|
74
89
|
},
|
|
75
90
|
build: () => ({ status: "run", args: [] }),
|
|
76
91
|
},
|
|
92
|
+
...BEHAVIOUR_STORE_VALIDATORS,
|
|
77
93
|
// Note: validate-runway-classification is intentionally NOT in the app set.
|
|
78
94
|
// It requires platform-level files (docs/platform/feature-tree.md,
|
|
79
95
|
// architecture-runway-index.md) that app repos don't own. Per ADR 0089,
|
|
@@ -126,6 +142,7 @@ const INTEGRATION_VALIDATORS = [
|
|
|
126
142
|
},
|
|
127
143
|
build: () => ({ status: "run", args: [] }),
|
|
128
144
|
},
|
|
145
|
+
...BEHAVIOUR_STORE_VALIDATORS,
|
|
129
146
|
];
|
|
130
147
|
const PLATFORM_VALIDATORS = [
|
|
131
148
|
{
|
|
@@ -208,6 +225,7 @@ const PLATFORM_VALIDATORS = [
|
|
|
208
225
|
},
|
|
209
226
|
build: () => ({ status: "run", args: [] }),
|
|
210
227
|
},
|
|
228
|
+
...BEHAVIOUR_STORE_VALIDATORS,
|
|
211
229
|
// Optional: the upstream validate-docs.sh dispatcher covers the 6
|
|
212
230
|
// conditional validators (backward-compatibility, deprecation-runway,
|
|
213
231
|
// migration-completeness, ddd-artifacts, glossary-alignment,
|
|
@@ -54,7 +54,7 @@ export async function runValidate(opts, stdout = (line) => process.stdout.write(
|
|
|
54
54
|
// passed" with none were previously the same line (M-ADR 0200 §4.3). The
|
|
55
55
|
// exit code is deliberately unchanged — the defect is the claim, not the
|
|
56
56
|
// gating; whether an unexecutable validator should FAIL is the open design
|
|
57
|
-
// question
|
|
57
|
+
// question, not this one.
|
|
58
58
|
function verdict(summary, selected) {
|
|
59
59
|
if (summary.exitCode !== 0)
|
|
60
60
|
return fail("One or more validators failed");
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The method-managed validation job, as DATA (
|
|
2
|
+
* The method-managed validation job, as DATA (M-ADR 0219).
|
|
3
3
|
*
|
|
4
4
|
* One ordered plan per profile: every default validator, the platform's script-only checks, then the
|
|
5
5
|
* advisory catalogue freshness check. Every executor renders or runs THIS: the GitHub workflow
|
|
@@ -22,6 +22,8 @@ const TITLES = {
|
|
|
22
22
|
"yaml-parse": "Validate that tracked YAML parses",
|
|
23
23
|
"gate-readiness": "Validate gate readiness",
|
|
24
24
|
"bundle-coherence": "Report bundle coherence",
|
|
25
|
+
"behaviour-store": "Validate the behaviour store: agreement records, the pre-apply gate, stale requirements, verdicts",
|
|
26
|
+
"behaviour-store-openspec": "Validate the behaviour store with OpenSpec (strict)",
|
|
25
27
|
// CI has no platform checkout, so this step runs the app-only checks; the met gate needs the platform beside it.
|
|
26
28
|
"app-dependencies": "Validate app dependencies (app-only checks; no platform checkout in CI)",
|
|
27
29
|
};
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
// with it certifies exactly the corruption a line-surgery transformer
|
|
11
11
|
// produces. `yaml` v2 refuses duplicate keys (DUPLICATE_KEY) and the other
|
|
12
12
|
// malformations a lenient parse glosses — e.g. a `: ` inside an unquoted
|
|
13
|
-
// scalar (`path: (none —
|
|
13
|
+
// scalar (`path: (none — see: docs)`), which no pattern rule catches.
|
|
14
14
|
//
|
|
15
15
|
// Scope: the YAML files git TRACKS (`*.yaml`, `*.yml`) — the repo's sources,
|
|
16
16
|
// not build output or dependencies. Outside a git work tree there is no
|
package/dist/verbs/sync.js
CHANGED
|
@@ -18,7 +18,7 @@ export function registerSync(program) {
|
|
|
18
18
|
.option("--allow-overwrite", "accept overwrites of locally-modified method content")
|
|
19
19
|
.option("--no-delete", "preserve files removed upstream")
|
|
20
20
|
.option("--agent-harness <name>", `target agent harness for hooks + briefing. Default: claude-code. Supported: ${AGENT_HARNESSES.join(", ")}`)
|
|
21
|
-
.option("--ci-binding <host>", `CI host whose wrapper calls the Method Validation module (M-ADR 0219): ${CI_BINDINGS.join(", ")}. Default: the binding the lock records, else github; a new choice is recorded in the lock`)
|
|
21
|
+
.option("--ci-binding <host>", `CI host whose wrapper calls the Method Validation module (M-ADR 0219): ${CI_BINDINGS.join(", ")}. local writes the module and no wrapper, for an estate that runs it with dagger call on its own machines, and removes the wrapper this tool wrote for the previous binding while it is unedited. Default: the binding the lock records, else github; a new choice is recorded in the lock`)
|
|
22
22
|
.option("--ci-runner <labels>", `runner label(s) the CI wrapper targets, comma-separated (GitHub runs-on, GitLab tags, Jenkins agent label), e.g. a self-hosted runner. '${CI_RUNNER_DEFAULT}' returns to the host's default runner. Default: what the lock records; a new choice is recorded`)
|
|
23
23
|
.option("--cli-source <source>", `where the session-start hook finds the verify CLI: ${CLI_SOURCES.join(" (npx at the pinned version) or ")} (sdd-verify from PATH, for an org that installs the release's CLI tarballs; the hook names the version to install when it differs). Default: what the lock records, else registry; a new choice is recorded`)
|
|
24
24
|
.option("--cli-package <name>", `the verify CLI's npm package under the registry source, for a registry that rescopes it. 'default' returns to ${DEFAULT_VERIFY_CLI_PACKAGE}. Default: what the lock records; a new choice is recorded`)
|
package/dist/verify-version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sdd-method/maintain-cli",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"sddCliVersion": "1.
|
|
3
|
+
"version": "0.5.0",
|
|
4
|
+
"sddCliVersion": "1.46.0",
|
|
5
5
|
"description": "Bring an SDD repository current and rebuild its derived model — sync, briefing, catalogue build and aggregate, pack build, context pull — plus every read-only verify verb. Ships only the code those verbs reach; it cannot author specification content. Authoring is in @sdd-method/sdd-cli.",
|
|
6
|
-
"license": "
|
|
6
|
+
"license": "UNLICENSED",
|
|
7
7
|
"type": "module",
|
|
8
8
|
"bin": {
|
|
9
9
|
"sdd-maintain": "dist/maintain-bin.js"
|
|
@@ -23,8 +23,6 @@
|
|
|
23
23
|
"files": [
|
|
24
24
|
"dist",
|
|
25
25
|
"scripts",
|
|
26
|
-
"README.md"
|
|
27
|
-
"LICENSE",
|
|
28
|
-
"NOTICE"
|
|
26
|
+
"README.md"
|
|
29
27
|
]
|
|
30
28
|
}
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
# 3b. (platform) that contract_path resolves to a file under the platform root
|
|
21
21
|
#
|
|
22
22
|
# Outputs a dependency status table.
|
|
23
|
-
# Used as the Stage 6
|
|
23
|
+
# Used as the Stage 6 agreement gate in the App Exploration Workflow.
|
|
24
24
|
#
|
|
25
25
|
# THE STABILITY VOCABULARY, AND WHY IT IS WHAT IT IS
|
|
26
26
|
# `required_stability` states the CONSUMING app's expectation of contract
|
|
@@ -157,8 +157,8 @@ APP_DEPS_FILE="$APP_ROOT/app-platform-dependencies.yaml"
|
|
|
157
157
|
#
|
|
158
158
|
# This gate read only the forward file, so an entire equal-status source went
|
|
159
159
|
# ungated. Measured in one reverse estate: 15 evidence files declaring 65
|
|
160
|
-
# further dependencies, 38 of them `locked` — precisely the
|
|
161
|
-
# a Stage 6
|
|
160
|
+
# further dependencies, 38 of them `locked` — precisely the population
|
|
161
|
+
# a Stage 6 agreement gate exists to check — none of which this gate could see.
|
|
162
162
|
#
|
|
163
163
|
# A source that the catalogue reads and the gate does not is a coverage gap by
|
|
164
164
|
# construction, so the gate now reads both.
|
|
@@ -637,7 +637,7 @@ main() {
|
|
|
637
637
|
fi
|
|
638
638
|
|
|
639
639
|
if [[ "$FAILURES" -gt 0 ]]; then
|
|
640
|
-
log_fail "$FAILURES dependency check(s) failed. Stage 6
|
|
640
|
+
log_fail "$FAILURES dependency check(s) failed. Stage 6 agreement gate NOT met."
|
|
641
641
|
exit 1
|
|
642
642
|
fi
|
|
643
643
|
|
|
@@ -656,7 +656,7 @@ main() {
|
|
|
656
656
|
if [[ "$WARNINGS" -gt 0 ]]; then
|
|
657
657
|
log_warn "All required checks passed with $WARNINGS warning(s)."
|
|
658
658
|
else
|
|
659
|
-
log_pass "All dependency checks passed. Stage 6
|
|
659
|
+
log_pass "All dependency checks passed. Stage 6 agreement gate met."
|
|
660
660
|
fi
|
|
661
661
|
exit 0
|
|
662
662
|
}
|
|
@@ -341,7 +341,7 @@ check_grounding_doc() {
|
|
|
341
341
|
|
|
342
342
|
local grounding="$REPO_ROOT/docs/design/integration/feature-grounding.md"
|
|
343
343
|
if [[ ! -f "$grounding" ]]; then
|
|
344
|
-
log_warn "docs/design/integration/feature-grounding.md not found — create before
|
|
344
|
+
log_warn "docs/design/integration/feature-grounding.md not found — create before agreement"
|
|
345
345
|
return
|
|
346
346
|
fi
|
|
347
347
|
|