@sdd-method/maintain-cli 0.10.0 → 0.11.0

package/dist/lib/intents/format.js

@@ -0,0 +1,77 @@
+// The intent artefact's shape (M-ADR 0227 §4.1), shared by the migration that writes intents and the check
+// that reads them. The section names and header lines are the shipped template's
+// (docs/method/methods/templates/intent-template.md), so a change there is a change here.
+export const INTENT_DIRS = ["content/method/intents", "content/product/intents"];
+export const INTENT_SECTIONS = [
+    "Problem",
+    "Proposed outcome",
+    "Affected users and systems",
+    "Constraints",
+    "Open questions",
+    "Decision to resolve in exploration",
+    "ADR requirement",
+    "Where it went",
+];
+/** Header fields of the retired Idea and the idea map: planning state, which belongs in the work item (§4.3). */
+export const PLANNING_FIELDS = [
+    "Status",
+    "Priority",
+    "Blocked by",
+    "Enables",
+    "Parent Idea",
+    "Child Ideas",
+    "Idea ID",
+    "Epic ID",
+    "Theme",
+];
+/** A "Where it went" line naming a path: "- `<path>` (<sdd-id>; <source>)". */
+export const WHERE_PATH_LINE = /^-\s+`([^`]+)`\s+\(([^;)]+);\s*([^)]+)\)\s*$/;
+/** "## 3. Why Explore This (Revised)" -> "why explore this". */
+export function normaliseHeading(h) {
+    return h
+        .replace(/^\s*\d+[A-Za-z]?(\.\d+)*\.?\s*/, "")
+        .replace(/\((revised|updated)\)\s*$/i, "")
+        .trim()
+        .toLowerCase();
+}
+export function parseMarkdown(text) {
+    const lines = text.split("\n");
+    let title = "";
+    const fields = new Map();
+    const sections = new Map();
+    const headings = [];
+    let current = null;
+    let buf = [];
+    const flush = () => {
+        if (current !== null) {
+            const prev = sections.get(current);
+            const body = buf.join("\n").trim();
+            sections.set(current, prev ? `${prev}\n\n${body}` : body);
+        }
+        buf = [];
+    };
+    for (const line of lines) {
+        const h1 = /^#\s+(.+?)\s*$/.exec(line);
+        if (h1 && !title && current === null) {
+            title = h1[1];
+            continue;
+        }
+        const h2 = /^##\s+(.+?)\s*$/.exec(line);
+        if (h2) {
+            flush();
+            headings.push(h2[1]);
+            current = normaliseHeading(h2[1]);
+            continue;
+        }
+        if (current === null) {
+            const f = /^\*\*([^*:]+):\*\*\s*(.*?)\s*$/.exec(line);
+            if (f)
+                fields.set(f[1].trim(), f[2]);
+            continue;
+        }
+        buf.push(line);
+    }
+    flush();
+    return { title, fields, sections, headings };
+}
+//# sourceMappingURL=format.js.map

package/dist/lib/validate/dispatch.js

@@ -1,6 +1,7 @@
 import { checkArchetypeCitations } from "./archetype-citations.js";
 import { checkBehaviourStore, checkBehaviourStoreOpenspec } from "./behaviour-store.js";
 import { checkBundleCoherence } from "./bundle-coherence.js";
+import { checkIntents } from "./intents.js";
 import { checkYamlParse } from "./yaml-parse.js";
 // The behaviour store (M-ADR 0221-0223) can sit in an SDD of any profile, so every profile carries
 // its two checks; without a store both report [N/A], an empty population, not a pass.
@@ -21,6 +22,12 @@ const BEHAVIOUR_STORE_VALIDATORS = [
         source: { kind: "native", run: async (ctx) => checkArchetypeCitations(ctx.targetRepo) },
         build: () => ({ status: "run", args: [] }),
     },
+    // Intents (M-ADR 0227) can sit in an SDD of any profile; without any the check reports [N/A].
+    {
+        name: "intents",
+        source: { kind: "native", run: async (ctx) => checkIntents(ctx.targetRepo) },
+        build: () => ({ status: "run", args: [] }),
+    },
 ];
 // Validators that accept --app-root / --repo-root flags work fine from the
 // bundled location because they override their internal ROOT_DIR via the

package/dist/lib/validate/intents.js

@@ -0,0 +1,76 @@
+// intents: every intent file (M-ADR 0227 §4.1) has the template's shape, carries no planning state, names its
+// work item, and every path its "Where it went" names in this SDD exists.
+//
+// Read from content/method/intents/ and content/product/intents/. A path line in "Where it went" is
+// "- `<path>` (<sdd-id>; <source>)"; only paths labelled with this SDD's id are checked here, since another
+// SDD's paths resolve in that SDD. Commit and plan lines are records, not paths, and are not checked. An
+// intent with nothing yet in "Where it went" is captured but not explored: counted, not failed. With no
+// intents the check reports [N/A], an empty population, not a pass.
+import { existsSync } from "node:fs";
+import { readdir, readFile } from "node:fs/promises";
+import { basename, join } from "node:path";
+import { parseDocument } from "yaml";
+import { INTENT_DIRS, INTENT_SECTIONS, PLANNING_FIELDS, WHERE_PATH_LINE, parseMarkdown } from "../intents/format.js";
+async function sddId(repo) {
+    try {
+        const m = parseDocument(await readFile(join(repo, ".sdd/sdd-manifest.yaml"), "utf8")).toJS();
+        if (typeof m?.sdd_id === "string" && m.sdd_id)
+            return m.sdd_id;
+    }
+    catch {
+        // fall through
+    }
+    return basename(repo);
+}
+export async function checkIntents(repo) {
+    const files = [];
+    for (const d of INTENT_DIRS) {
+        try {
+            for (const e of await readdir(join(repo, d), { withFileTypes: true })) {
+                if (e.isFile() && e.name.endsWith(".md") && e.name.toLowerCase() !== "readme.md")
+                    files.push(`${d}/${e.name}`);
+            }
+        }
+        catch {
+            // no such directory
+        }
+    }
+    if (files.length === 0)
+        return { exitCode: 0, stdout: "[N/A] no intents (content/{method,product}/intents/*.md) in this repository\n" };
+    const self = await sddId(repo);
+    const problems = [];
+    let unexplored = 0;
+    let pathsChecked = 0;
+    for (const rel of files.sort()) {
+        const text = await readFile(join(repo, rel), "utf8");
+        const doc = parseMarkdown(text);
+        if (!/^Intent:\s*\S/.test(doc.title))
+            problems.push(`${rel}: no "# Intent: <title>" line`);
+        for (const s of INTENT_SECTIONS)
+            if (!doc.sections.has(s.toLowerCase()))
+                problems.push(`${rel}: no "## ${s}" section`);
+        const wi = doc.fields.get("Work item")?.trim() ?? "";
+        if (!wi || /^<.*>$/.test(wi))
+            problems.push(`${rel}: no work item named (**Work item:**)`);
+        for (const f of PLANNING_FIELDS)
+            if (doc.fields.has(f))
+                problems.push(`${rel}: planning field **${f}:** belongs in the work item (M-ADR 0227 §4.3)`);
+        const where = (doc.sections.get("where it went") ?? "").split("\n").map((l) => l.trim()).filter((l) => l.startsWith("- "));
+        if (where.length === 0)
+            unexplored++;
+        for (const line of where) {
+            const m = WHERE_PATH_LINE.exec(line);
+            if (!m || m[2].trim() !== self)
+                continue;
+            pathsChecked++;
+            const p = m[1].replace(/[#?].*$/, "");
+            if (!existsSync(join(repo, p)))
+                problems.push(`${rel}: "Where it went" names ${p}, which does not exist`);
+        }
+    }
+    const head = `intents: ${files.length} intent(s); ${pathsChecked} "Where it went" path(s) in this SDD checked; ${unexplored} not yet explored\n`;
+    if (problems.length === 0)
+        return { exitCode: 0, stdout: `${head}[PASS] intents: ok\n` };
+    return { exitCode: 1, stdout: `${head}${problems.map((p) => `[FAIL] ${p}\n`).join("")}[FAIL] intents: ${problems.length} problem(s)\n` };
+}
+//# sourceMappingURL=intents.js.map

package/dist/maintain-version.json

@@ -1,4 +1,4 @@
 {
-  "version": "0.10.0",
-  "built_against_sdd_cli": "2.4.0"
+  "version": "0.11.0",
+  "built_against_sdd_cli": "2.5.0"
 }

package/dist/verify-version.json

@@ -1,4 +1,4 @@
 {
-  "version": "2.4.0",
-  "built_against_sdd_cli": "2.4.0"
+  "version": "2.5.0",
+  "built_against_sdd_cli": "2.5.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sdd-method/maintain-cli",
-  "version": "0.10.0",
-  "sddCliVersion": "2.4.0",
+  "version": "0.11.0",
+  "sddCliVersion": "2.5.0",
   "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.",
   "license": "UNLICENSED",
   "type": "module",