mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-16 04:45:33 -08:00
674 lines
36 KiB
JavaScript
674 lines
36 KiB
JavaScript
// Web console tests, the spec states: public/spec-states.js defines every
|
|
// state the dashboard scan can report, and the labels, next steps and card
|
|
// rules are lookups on it.
|
|
// Run with: node --test scripts/test-web-console-spec-states.mjs
|
|
|
|
import test from "node:test";
|
|
import assert from "node:assert/strict";
|
|
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { spawnSync } from "node:child_process";
|
|
import { fileURLToPath } from "node:url";
|
|
import { SPEC_STATES as TABLE, stateFor } from "../src/web-console/public/spec-states.js";
|
|
import { SKILLS } from "../src/web-console/public/skills.js";
|
|
import { SKILL_CATALOG, cardAvailability, defaultSpec, launchVariant } from "../src/web-console/public/answers.js";
|
|
import { scanProject } from "../src/web-console/scan.mjs";
|
|
import { MARKERS, TASK_LINE_RE, TASK_ID_RE, CHECKBOX_RE, STATUS_RE, statusOf, countTasks, deriveSpecState, pickPhaseFiles } from "../src/web-console/spec-files.mjs";
|
|
|
|
// The task pattern specs.mjs used before spec-files.mjs: TASK_ID_RE must take
|
|
// a `-` task line apart into the same groups.
|
|
const OLD_TASK_RE = /^\s*[-*] \[(.)\]\s+\*\*Task\s+(\d+)\.(\d+|[A-Za-z]+)([a-z]*)\b/;
|
|
|
|
test("spec files: every marker names its state, and the table is frozen", () => {
|
|
assert.deepEqual(MARKERS, { " ": "pending", "/": "in-progress", x: "complete", X: "complete", "!": "blocked", "?": "assumed" });
|
|
assert.ok(Object.isFrozen(MARKERS));
|
|
});
|
|
|
|
test("spec files: -, * and numbered task lines all match, and TASK_ID_RE keeps the old groups", () => {
|
|
for (const line of ["- [ ] **Task 1.2:** Do it", "* [x] **Task 1.2:** Do it", "1. [/] **Task 1.2:** Do it", " 12. [?] **Task 3.4:** Do it"]) {
|
|
assert.ok(TASK_LINE_RE.test(line), `TASK_LINE_RE matches ${line}`);
|
|
assert.ok(TASK_ID_RE.test(line), `TASK_ID_RE matches ${line}`);
|
|
assert.ok(CHECKBOX_RE.test(line), `CHECKBOX_RE matches ${line}`);
|
|
}
|
|
assert.ok(!TASK_LINE_RE.test("- [ ] Acceptance: it works"), "a plain checkbox is no task line");
|
|
// A line TASK_ID_RE cannot take apart is no task line for the scan either.
|
|
for (const line of ["- [x] **task 1.1:** Lowercase", "- [x] **Task 1.1:** Two spaces"]) {
|
|
assert.ok(!TASK_ID_RE.test(line) && !TASK_LINE_RE.test(line), `neither pattern takes ${line}`);
|
|
}
|
|
assert.ok(CHECKBOX_RE.test("- [ ] Acceptance: it works"), "but it is a checkbox");
|
|
for (const line of ["- [x] **Task 2.3:** Build it", "- [ ] **Task 1.B:** Name it", "- [/] **Task 4.2a:** Split it"]) {
|
|
assert.deepEqual([...line.match(TASK_ID_RE)], [...line.match(OLD_TASK_RE)], `the same groups for ${line}`);
|
|
}
|
|
assert.deepEqual("1. [x] **Task 2.3:** Build it".match(TASK_ID_RE).slice(1), ["x", "2", "3", ""], "a numbered line's groups");
|
|
});
|
|
|
|
test("spec files: statusOf() reads every Status form, LF or CRLF, and is null without one", () => {
|
|
const forms = { "**Status:** Complete": "Complete", "**Status**: In Progress": "In Progress", "Status: Not Started": "Not Started" };
|
|
for (const [line, value] of Object.entries(forms)) {
|
|
for (const eol of ["\n", "\r\n"]) {
|
|
const text = `# Phase 1${eol}${eol}${line}${eol}**Estimated Tasks:** 3${eol}`;
|
|
assert.equal(statusOf(text), value, `${line} with ${eol === "\n" ? "LF" : "CRLF"}`);
|
|
assert.equal(text.match(STATUS_RE)[1] + text.match(STATUS_RE)[2], line, "the prefix and value rebuild the line");
|
|
}
|
|
}
|
|
assert.equal(statusOf("# Phase 1\n\nNo status here.\n"), null);
|
|
assert.equal(statusOf(""), null);
|
|
assert.equal(statusOf(undefined), null);
|
|
});
|
|
|
|
test("spec files: countTasks() counts task lines only when there are any, every checkbox otherwise", () => {
|
|
const phase = [
|
|
"# Phase 1",
|
|
"- [x] **Task 1.1:** One",
|
|
"* [?] **Task 1.2:** Two",
|
|
"1. [ ] **Task 1.3:** Three",
|
|
"- [/] **Task 1.4:** Four",
|
|
"- [!] **Task 1.5:** Five",
|
|
"- [~] **Task 1.6:** An unknown marker",
|
|
"## Acceptance Criteria",
|
|
"- [ ] It works",
|
|
"- [x] It is fast",
|
|
].join("\r\n");
|
|
// [~] is an unknown marker: not done, so it counts as open.
|
|
assert.deepEqual(countTasks(phase), { done: 1, assumed: 1, open: 3, blocked: 1, bare: 1, total: 6 });
|
|
const older = "# Phase 1\n\n- [x] Make it\n- [ ] Ship it\n- [?] Check it\n";
|
|
assert.deepEqual(countTasks(older), { done: 1, assumed: 1, open: 1, blocked: 0, bare: 0, total: 3 });
|
|
assert.deepEqual(countTasks(""), { done: 0, assumed: 0, open: 0, blocked: 0, bare: 0, total: 0 });
|
|
});
|
|
|
|
// What the picker labels each state and which card each state lights, as
|
|
// answers.js's SPEC_STATE_LABELS and NEXT_FOR_STATE said before the table.
|
|
const LABELS = {
|
|
diagnosed: "Bug diagnosed",
|
|
fixed: "Bug fixed",
|
|
exploring: "Exploring",
|
|
mapped: "Ready to plan",
|
|
planned: "Ready to document",
|
|
documented: "Ready to build",
|
|
building: "Building",
|
|
built: "Ready to finalize",
|
|
unrecognized: "Files on disk",
|
|
};
|
|
const NEXT = {
|
|
diagnosed: "plan2code-quick-task",
|
|
fixed: null,
|
|
exploring: "plan2code-0-pathfinder",
|
|
mapped: "plan2code-1-plan",
|
|
planned: "plan2code-2-document",
|
|
documented: "plan2code-3-implement",
|
|
building: "plan2code-3-implement",
|
|
built: "plan2code-4-finalize",
|
|
unrecognized: null,
|
|
};
|
|
|
|
test("spec states: each state keeps its label and next step, and only fixed is finished", () => {
|
|
assert.deepEqual(Object.keys(TABLE), Object.keys(LABELS), "the states, in the scan's order");
|
|
for (const [name, label] of Object.entries(LABELS)) {
|
|
const s = stateFor(name);
|
|
assert.ok(s, `${name} is in the table`);
|
|
assert.equal(s.label, label, `${name}'s label`);
|
|
assert.equal(s.next, NEXT[name], `${name}'s next step`);
|
|
assert.equal(s.finished, name === "fixed", `${name}'s finished flag`);
|
|
}
|
|
assert.equal(stateFor("made-up"), null, "an unknown state is null");
|
|
assert.ok(Object.isFrozen(TABLE) && Object.values(TABLE).every(Object.isFrozen), "the table is frozen");
|
|
});
|
|
|
|
// Every card's answer for every picker selection, as cardAvailability() gave
|
|
// them before the card rules moved onto skills.js: generated once from that
|
|
// code and written out here, so the move is proven to change nothing. "none"
|
|
// is "start from scratch" (no spec picked). The scan is a set-up git project
|
|
// with nothing to commit; SCAN_CASES covers the three cards that read it.
|
|
const SCAN = { hasAgents: true, isGit: true, pending: 0 };
|
|
const CARDS = {
|
|
"plan2code-init": {
|
|
"none": { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
diagnosed: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
fixed: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
exploring: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
mapped: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
planned: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
documented: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
building: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
built: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
unrecognized: { on: false, reason: "AGENTS.md is already written. Refresh it instead." },
|
|
},
|
|
"plan2code-init-update": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-0-pathfinder": {
|
|
"none": { on: true, next: true },
|
|
diagnosed: { on: false, reason: "The cause is found. Fix it in a quick task, or plan it." },
|
|
fixed: { on: false, reason: "This bug is fixed. Delete it with the Delete button on its chip, or move it to specs--completed/." },
|
|
exploring: { on: true, next: true },
|
|
mapped: { on: false, reason: "This spec is already past the questions" },
|
|
planned: { on: false, reason: "This spec is already past the questions" },
|
|
documented: { on: false, reason: "This spec is already past the questions" },
|
|
building: { on: false, reason: "This spec is already past the questions" },
|
|
built: { on: false, reason: "This spec is already past the questions" },
|
|
unrecognized: { on: true, next: false },
|
|
},
|
|
"plan2code-1-plan": {
|
|
"none": { on: true, next: false },
|
|
diagnosed: { on: true, next: false },
|
|
fixed: { on: false, reason: "This bug is fixed. Delete it with the Delete button on its chip, or move it to specs--completed/." },
|
|
exploring: { on: false, reason: "Pathfinder is not finished with this spec yet" },
|
|
mapped: { on: true, next: true },
|
|
planned: { on: true, next: false },
|
|
documented: { on: false, reason: "The plan is written. Revise it instead if it moved." },
|
|
building: { on: false, reason: "The plan is written. Revise it instead if it moved." },
|
|
built: { on: false, reason: "The plan is written. Revise it instead if it moved." },
|
|
unrecognized: { on: true, next: false },
|
|
},
|
|
"plan2code-1b-revise-plan": {
|
|
"none": { on: false, reason: "Needs a spec that is already written up" },
|
|
diagnosed: { on: false, reason: "Needs a spec that is already written up" },
|
|
fixed: { on: false, reason: "Needs a spec that is already written up" },
|
|
exploring: { on: false, reason: "Needs a spec that is already written up" },
|
|
mapped: { on: false, reason: "Needs a spec that is already written up" },
|
|
planned: { on: false, reason: "Needs a spec that is already written up" },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: false, reason: "Needs a spec that is already written up" },
|
|
},
|
|
"plan2code-2-document": {
|
|
"none": { on: false, reason: "Needs a drafted plan first" },
|
|
diagnosed: { on: false, reason: "Needs a drafted plan first" },
|
|
fixed: { on: false, reason: "Needs a drafted plan first" },
|
|
exploring: { on: false, reason: "Needs a drafted plan first" },
|
|
mapped: { on: false, reason: "Needs a drafted plan first" },
|
|
planned: { on: true, next: true },
|
|
documented: { on: false, reason: "The phases are already written up" },
|
|
building: { on: false, reason: "The phases are already written up" },
|
|
built: { on: false, reason: "The phases are already written up" },
|
|
unrecognized: { on: false, reason: "Needs a drafted plan first" },
|
|
},
|
|
"plan2code-3-implement": {
|
|
"none": { on: false, reason: "Needs the phase checklists written up first" },
|
|
diagnosed: { on: false, reason: "Needs the phase checklists written up first" },
|
|
fixed: { on: false, reason: "Needs the phase checklists written up first" },
|
|
exploring: { on: false, reason: "Needs the phase checklists written up first" },
|
|
mapped: { on: false, reason: "Needs the phase checklists written up first" },
|
|
planned: { on: false, reason: "Needs the phase checklists written up first" },
|
|
documented: { on: true, next: true },
|
|
building: { on: true, next: true },
|
|
built: { on: false, reason: "All tasks are already done" },
|
|
unrecognized: { on: false, reason: "Needs the phase checklists written up first" },
|
|
},
|
|
"plan2code-3-implement-review": {
|
|
"none": { on: false, reason: "Needs the phase checklists written up first" },
|
|
diagnosed: { on: false, reason: "Needs the phase checklists written up first" },
|
|
fixed: { on: false, reason: "Needs the phase checklists written up first" },
|
|
exploring: { on: false, reason: "Needs the phase checklists written up first" },
|
|
mapped: { on: false, reason: "Needs the phase checklists written up first" },
|
|
planned: { on: false, reason: "Needs the phase checklists written up first" },
|
|
documented: { on: true, next: false },
|
|
building: { on: true, next: false },
|
|
built: { on: false, reason: "All tasks are already done" },
|
|
unrecognized: { on: false, reason: "Needs the phase checklists written up first" },
|
|
},
|
|
"plan2code-4-finalize": {
|
|
"none": { on: false, reason: "Needs a spec that is fully built" },
|
|
diagnosed: { on: false, reason: "Needs a spec that is fully built" },
|
|
fixed: { on: false, reason: "Needs a spec that is fully built" },
|
|
exploring: { on: false, reason: "Needs a spec that is fully built" },
|
|
mapped: { on: false, reason: "Needs a spec that is fully built" },
|
|
planned: { on: false, reason: "Needs a spec that is fully built" },
|
|
documented: { on: false, reason: "Needs a spec that is fully built" },
|
|
building: { on: false, reason: "Needs a spec that is fully built" },
|
|
built: { on: true, next: true },
|
|
unrecognized: { on: false, reason: "Needs a spec that is fully built" },
|
|
},
|
|
"plan2code-quick-task": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true, next: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-review": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-xray": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-diagnose": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-pr-prep": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-test": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-changelog": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-git": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
"plan2code-handoff": {
|
|
"none": { on: true },
|
|
diagnosed: { on: true },
|
|
fixed: { on: true },
|
|
exploring: { on: true },
|
|
mapped: { on: true },
|
|
planned: { on: true },
|
|
documented: { on: true },
|
|
building: { on: true },
|
|
built: { on: true },
|
|
unrecognized: { on: true },
|
|
},
|
|
};
|
|
|
|
// Implement's card also launches Implement + Review, which has the same rules.
|
|
const CARD_ENTRIES = SKILL_CATALOG.flatMap((e) => (e.review ? [e, launchVariant(e, true)] : [e]));
|
|
|
|
const SCAN_CASES = [
|
|
[{ hasAgents: false, isGit: false, pending: null }, "plan2code-init", { on: true }],
|
|
[{ hasAgents: false, isGit: false, pending: null }, "plan2code-init-update", { on: false, reason: "Needs an AGENTS.md. Set the project up first." }],
|
|
[{ hasAgents: false, isGit: false, pending: null }, "plan2code-git", { on: true, note: "Not a git repository yet: it offers to start one" }],
|
|
[{ hasAgents: true, isGit: true, pending: 3 }, "plan2code-init", { on: false, reason: "AGENTS.md is already written. Refresh it instead." }],
|
|
[{ hasAgents: true, isGit: true, pending: 3 }, "plan2code-init-update", { on: true }],
|
|
[{ hasAgents: true, isGit: true, pending: 3 }, "plan2code-git", { on: true, note: "3 files to commit" }],
|
|
[{ hasAgents: true, isGit: true, pending: 1 }, "plan2code-init", { on: false, reason: "AGENTS.md is already written. Refresh it instead." }],
|
|
[{ hasAgents: true, isGit: true, pending: 1 }, "plan2code-init-update", { on: true }],
|
|
[{ hasAgents: true, isGit: true, pending: 1 }, "plan2code-git", { on: true, note: "1 file to commit" }],
|
|
];
|
|
|
|
test("card rules: every card gives the same answer for every spec state as before", () => {
|
|
assert.deepEqual(CARD_ENTRIES.map((e) => e.skill), Object.keys(CARDS), "one row per card, in card order");
|
|
for (const entry of CARD_ENTRIES) {
|
|
for (const [sel, want] of Object.entries(CARDS[entry.skill])) {
|
|
const spec = sel === "none" ? null : { dir: "specs/x", name: "x", state: sel };
|
|
assert.deepEqual(cardAvailability(entry, SCAN, spec), want, `${entry.skill} with ${sel}`);
|
|
}
|
|
}
|
|
});
|
|
|
|
test("card rules: a state the table does not know is treated like files on disk", () => {
|
|
for (const entry of CARD_ENTRIES) {
|
|
const weird = cardAvailability(entry, SCAN, { dir: "specs/x", name: "x", state: "made-up" });
|
|
assert.deepEqual(weird, CARDS[entry.skill].unrecognized, `${entry.skill} with an unknown state`);
|
|
}
|
|
});
|
|
|
|
test("card rules: Init, Init update and Git read the scan, not the spec", () => {
|
|
for (const [scan, skill, want] of SCAN_CASES) {
|
|
const entry = SKILL_CATALOG.find((e) => e.skill === skill);
|
|
assert.deepEqual(cardAvailability(entry, scan, null), want, `${skill} with ${JSON.stringify(scan)}`);
|
|
}
|
|
});
|
|
|
|
test("finished: any finished state is never the picker's default, not only fixed", () => {
|
|
// The test's own copy of the table, with a made-up second finished state.
|
|
const table = { ...TABLE, archived: { label: "Archived", next: null, finished: true } };
|
|
const lookup = (name) => (Object.hasOwn(table, name) ? table[name] : null);
|
|
const specs = [
|
|
{ dir: "specs/a", name: "a", state: "archived" },
|
|
{ dir: "specs/b", name: "b", state: "fixed" },
|
|
{ dir: "specs/c", name: "c", state: "planned" },
|
|
];
|
|
assert.equal(defaultSpec(specs, lookup)?.dir, "specs/c", "the newest spec still in play");
|
|
assert.equal(defaultSpec(specs.slice(0, 2), lookup), null, "only finished specs: start from scratch");
|
|
assert.equal(defaultSpec(specs)?.dir, "specs/a", "the real table does not know archived, so it is in play");
|
|
|
|
// The cards grayed for a fixed bug give a made-up finished state the same reason.
|
|
const archived = { dir: "specs/a", name: "a", state: "archived" };
|
|
for (const entry of CARD_ENTRIES) {
|
|
const fixed = cardAvailability(entry, SCAN, { dir: "specs/b", name: "b", state: "fixed" });
|
|
assert.deepEqual(cardAvailability(entry, SCAN, archived, lookup), fixed, `${entry.skill} treats archived as it treats fixed`);
|
|
}
|
|
});
|
|
|
|
// One spec folder per state, in the shapes classifySpec() reads.
|
|
const PHASE = (ticks) => "# Phase 1\n\n" + ticks.map((x, i) => `- [${x ? "x" : " "}] **Task 1.${i + 1}:** Step ${i + 1}\n`).join("");
|
|
const FIXTURES = {
|
|
diagnosed: { "DIAGNOSIS-20261017.md": "# Diagnosis\n\n**Status:** Diagnosed\n" },
|
|
fixed: { "DIAGNOSIS-20261017.md": "# Diagnosis\n\n**Status:** Fixed\n" },
|
|
exploring: { "pathfinder/map.md": "# Map\n\nStatus: Working\n" },
|
|
mapped: { "PLAN-DRAFT-20261017.md": "# Plan draft\n\n**Status:** Phase 3 Complete - Resume at Phase 4\n" },
|
|
planned: { "PLAN-DRAFT-20261017.md": "# Plan draft\n\n**Status:** Draft\n" },
|
|
documented: { "overview.md": "# Overview\n", "phase-1.md": PHASE([false, false]) },
|
|
building: { "overview.md": "# Overview\n", "phase-1.md": PHASE([true, false]) },
|
|
built: { "overview.md": "# Overview\n", "phase-1.md": PHASE([true, true]) },
|
|
unrecognized: { "notes.md": "Some loose notes.\n" },
|
|
};
|
|
|
|
// The states a scan of these fixtures reports, against the table's: the
|
|
// lines that name what does not match, empty when they agree.
|
|
function scanProblems(fixtures, table) {
|
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-spec-states-"));
|
|
try {
|
|
for (const [name, files] of Object.entries(fixtures))
|
|
for (const [rel, text] of Object.entries(files)) {
|
|
const file = path.join(root, "specs", name, rel);
|
|
fs.mkdirSync(path.dirname(file), { recursive: true });
|
|
fs.writeFileSync(file, text);
|
|
}
|
|
const scan = scanProject(root);
|
|
const problems = scan.specs.filter((sp) => sp.state !== sp.name).map((sp) => `the ${sp.name} fixture scans as ${sp.state}`);
|
|
const seen = new Set(scan.specs.map((sp) => sp.state));
|
|
for (const state of seen) if (!Object.hasOwn(table, state)) problems.push(`the scan returns ${state}, which spec-states.js lacks`);
|
|
for (const state of Object.keys(table)) if (!seen.has(state)) problems.push(`no fixture reaches ${state}: add one, or drop it from spec-states.js`);
|
|
return problems;
|
|
} finally {
|
|
fs.rmSync(root, { recursive: true, force: true });
|
|
}
|
|
}
|
|
|
|
test("the scan: every state it can return is in the table, and a fixture reaches every state in it", () => {
|
|
assert.deepEqual(scanProblems(FIXTURES, TABLE), []);
|
|
// The check names what is missing.
|
|
const { built, ...short } = FIXTURES;
|
|
assert.deepEqual(scanProblems(short, TABLE), ["no fixture reaches built: add one, or drop it from spec-states.js"]);
|
|
const { unrecognized, ...known } = TABLE;
|
|
assert.deepEqual(scanProblems(FIXTURES, known), ["the scan returns unrecognized, which spec-states.js lacks"]);
|
|
});
|
|
|
|
test("the scan: a PR-READINESS report changes no spec's state, and alone it stays unrecognized", () => {
|
|
const scanOf = (fixtures) => {
|
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-spec-readiness-"));
|
|
try {
|
|
for (const [name, files] of Object.entries(fixtures))
|
|
for (const [rel, text] of Object.entries(files)) {
|
|
const file = path.join(root, "specs", name, rel);
|
|
fs.mkdirSync(path.dirname(file), { recursive: true });
|
|
fs.writeFileSync(file, text);
|
|
}
|
|
return Object.fromEntries(scanProject(root).specs.map((sp) => [sp.name, [sp.state, sp.detail]]));
|
|
} finally {
|
|
fs.rmSync(root, { recursive: true, force: true });
|
|
}
|
|
};
|
|
const REPORT = { "PR-READINESS-20261103.md": "# PR readiness\n\n**Verdict:** Ready\n\n- [x] Unit tests\n- [ ] Lint (trimmed)\n" };
|
|
const withReport = Object.fromEntries(Object.entries(FIXTURES).map(([name, files]) => [name, { ...files, ...REPORT }]));
|
|
assert.deepEqual(scanOf(withReport), scanOf(FIXTURES));
|
|
assert.equal(scanOf({ only: REPORT }).only[0], "unrecognized");
|
|
});
|
|
|
|
test("the scan: an assumed task counts as done and is named, and numbered task lines count", () => {
|
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-spec-assumed-"));
|
|
const specs = {
|
|
mixed: "- [x] **Task 1.1:** One\n- [x] **Task 1.2:** Two\n- [?] **Task 1.3:** Three\n- [ ] **Task 1.4:** Four\n",
|
|
assumed: "- [?] **Task 1.1:** One\n- [?] **Task 1.2:** Two\n",
|
|
numbered: "1. [x] **Task 1.1:** One\n2. [ ] **Task 1.2:** Two\n3. [ ] **Task 1.3:** Three\n",
|
|
plain: "- [x] **Task 1.1:** One\n- [x] **Task 1.2:** Two\n",
|
|
};
|
|
try {
|
|
for (const [name, phase] of Object.entries(specs)) {
|
|
fs.mkdirSync(path.join(root, "specs", name), { recursive: true });
|
|
fs.writeFileSync(path.join(root, "specs", name, "overview.md"), "# Overview\n");
|
|
fs.writeFileSync(path.join(root, "specs", name, "phase-1.md"), "# Phase 1\n\n" + phase + "\n## Acceptance Criteria\n\n- [ ] It works\n");
|
|
}
|
|
const by = Object.fromEntries(scanProject(root).specs.map((sp) => [sp.name, sp]));
|
|
assert.deepEqual([by.mixed.state, by.mixed.detail], ["building", "3 of 4 tasks done, 1 assumed"]);
|
|
assert.deepEqual([by.assumed.state, by.assumed.detail], ["built", "all tasks done, 2 assumed"]);
|
|
assert.deepEqual([by.numbered.state, by.numbered.detail], ["building", "1 of 3 tasks done"]);
|
|
assert.deepEqual([by.plain.state, by.plain.detail], ["built", "all tasks done"], "no assumed tasks, no \", 0 assumed\"");
|
|
} finally {
|
|
fs.rmSync(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
// The seven cases where the dashboard scan and specs.mjs once disagreed
|
|
// (recorded in the hardening spec's Phase 5 notes; the same cases are in
|
|
// test-skill-scripts.mjs). Each is a spec folder and the
|
|
// [state, detail, finalizeReady] both must now report.
|
|
const DESYNC_CHECKLIST = (...marks) => `# Overview\n\n## Phase Checklist\n\n${marks.map((m, i) => `- [${m}] [Phase ${i + 1}: Step ${i + 1}](./phase-${i + 1}.md)`).join("\n")}\n`;
|
|
const DESYNC_PHASE = (n, lines) => `# Phase ${n}: Step ${n}\n\n**Status:** In Progress\n\n## Tasks\n\n${lines.join("\n")}\n\n## Acceptance Criteria\n\n- It works\n`;
|
|
const DESYNC_CASES = {
|
|
"blocked-reasoned": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("x"), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One", "- [!] **Task 1.2:** Two", " > BLOCKED: needs admin access. User action: create the app."]) },
|
|
want: ["building", "1 of 2 tasks done, 1 blocked", true],
|
|
},
|
|
"unknown-marker": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("/"), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One", "- [~] **Task 1.2:** Two"]) },
|
|
want: ["building", "1 of 2 tasks done", false],
|
|
},
|
|
"row-without-file": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("x", " "), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One", "- [x] **Task 1.2:** Two"]) },
|
|
want: ["building", "2 of 2 tasks done, Phase 2 not written up", false],
|
|
},
|
|
"phase-without-tasks": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("x", " "), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One"]), "phase-2.md": DESYNC_PHASE(2, ["To be written."]) },
|
|
want: ["building", "1 of 1 tasks done, Phase 2 not written up", false],
|
|
},
|
|
"stale-duplicate": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("x"), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One"]), "phase-1-old.md": DESYNC_PHASE(1, ["- [ ] **Task 1.1:** One", "- [ ] **Task 1.2:** Two"]) },
|
|
want: ["built", "all tasks done", false],
|
|
},
|
|
"not-a-phase-file": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("x"), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One"]), "phase-notes.md": "# Notes\n\n- [ ] Ask about colors\n" },
|
|
want: ["built", "all tasks done", false],
|
|
},
|
|
"blocked-bare": {
|
|
files: { "overview.md": DESYNC_CHECKLIST("x"), "phase-1.md": DESYNC_PHASE(1, ["- [x] **Task 1.1:** One", "- [!] **Task 1.2:** Two"]) },
|
|
want: ["building", "1 of 2 tasks done, 1 blocked", false],
|
|
},
|
|
};
|
|
|
|
const SPECS_SCRIPT = path.join(path.dirname(fileURLToPath(import.meta.url)), "..", "src", "skill-scripts", "specs.mjs");
|
|
|
|
test("the scan: the dashboard and specs.mjs status report the same state on the seven desync cases", () => {
|
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-spec-desync-"));
|
|
try {
|
|
for (const [name, c] of Object.entries(DESYNC_CASES))
|
|
for (const [rel, text] of Object.entries(c.files)) {
|
|
fs.mkdirSync(path.join(root, "specs", name), { recursive: true });
|
|
fs.writeFileSync(path.join(root, "specs", name, rel), text);
|
|
}
|
|
const by = Object.fromEntries(scanProject(root).specs.map((sp) => [sp.name, sp]));
|
|
for (const [name, c] of Object.entries(DESYNC_CASES)) {
|
|
assert.deepEqual([by[name].state, by[name].detail, Boolean(by[name].finalizeReady)], c.want, `${name}: the dashboard scan`);
|
|
const r = spawnSync(process.execPath, [SPECS_SCRIPT, "status", name, "--root", root], { encoding: "utf8" });
|
|
assert.equal(r.status, 0, r.stderr);
|
|
const st = JSON.parse(r.stdout);
|
|
assert.deepEqual([st.state, st.stateDetail, st.finalizeReady], c.want, `${name}: specs.mjs status`);
|
|
}
|
|
} finally {
|
|
fs.rmSync(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("deriveSpecState: blocked tasks keep a spec building, and finalizeReady needs a reason on each", () => {
|
|
const phase = (lines) => [{ number: 1, text: `# Phase 1\n\n${lines.join("\n")}\n` }];
|
|
const ready = deriveSpecState({ phases: phase(["- [x] **Task 1.1:** One", "- [!] **Task 1.2:** Two Blocked: no key yet", "- [!] **Task 1.3:** Three", " Reason: waiting on legal"]) });
|
|
assert.deepEqual([ready.state, ready.detail, ready.finalizeReady, ready.blocked, ready.bare], ["building", "1 of 3 tasks done, 2 blocked", true, 2, 0]);
|
|
const open = deriveSpecState({ phases: phase(["- [x] **Task 1.1:** One", "- [!] **Task 1.2:** Two", " > BLOCKED: no key.", "- [ ] **Task 1.3:** Three"]) });
|
|
assert.deepEqual([open.state, open.finalizeReady], ["building", false], "an open task left keeps Finalize dark");
|
|
// A reason belongs to its own task: the next task's line does not lend one.
|
|
const borrowed = deriveSpecState({ phases: phase(["- [x] **Task 1.1:** One", "- [!] **Task 1.2:** Two", "- [x] **Task 1.3:** Blocked: on purpose"]) });
|
|
assert.deepEqual([borrowed.bare, borrowed.finalizeReady], [1, false]);
|
|
assert.equal(deriveSpecState({ phases: phase(["- [!] **Task 1.1:** One", " > BLOCKED: no key."]) }).state, "documented", "nothing done yet is still documented");
|
|
// An approved phase with no task lines is not waiting to be written up.
|
|
const approved = deriveSpecState({ overview: "## Phase Checklist\n\n- [x] Phase 1: One\n- [x] Phase 2: Two\n", phases: [...phase(["- [x] **Task 1.1:** One"]), { number: 2, text: "# Phase 2\n" }] });
|
|
assert.deepEqual([approved.state, approved.unwritten], ["built", []]);
|
|
});
|
|
|
|
test("pickPhaseFiles: one file per phase number, the exact phase-N.md first, the rest listed as extra", () => {
|
|
const picked = pickPhaseFiles(["phase-2-old.md", "phase-2.md", "phase-1-setup.md", "phase-notes.md", "overview.md", "phase-10.md"]);
|
|
assert.deepEqual([...picked.entries()].sort((a, b) => a[0] - b[0]), [[1, "phase-1-setup.md"], [2, "phase-2.md"], [10, "phase-10.md"]]);
|
|
assert.deepEqual([...picked.extra.entries()], [[2, ["phase-2-old.md"]]]);
|
|
});
|
|
|
|
test("card rules: Finalize lights for a building spec only when the scan says finalizeReady", () => {
|
|
const entry = SKILL_CATALOG.find((e) => e.skill === "plan2code-4-finalize");
|
|
const spec = (extra) => ({ dir: "specs/x", name: "x", state: "building", ...extra });
|
|
assert.equal(cardAvailability(entry, SCAN, spec({ finalizeReady: true })).on, true);
|
|
assert.equal(cardAvailability(entry, SCAN, spec({})).on, false);
|
|
assert.equal(cardAvailability(entry, SCAN, { dir: "specs/x", name: "x", state: "documented", finalizeReady: true }).on, false, "only a building spec");
|
|
});
|
|
|
|
test("the scan: planChange is true for a waiting Plan change brief, and absent once it is applied or dropped", () => {
|
|
const root = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-spec-brief-"));
|
|
const notes = (line) => "# Phase 1\n\n- [x] **Task 1.1:** One\n- [ ] **Task 1.2:** Two\n\n## Notes\n\n### Paused 2026-10-27\n" + line + "\n\n## Phase Completion Summary\n";
|
|
const checklist = (mark) => `# Overview\n\n## Phase Checklist\n\n- [${mark}] Phase 1: One\n- [ ] Phase 2: Two\n`;
|
|
const specs = {
|
|
waiting: { "overview.md": checklist("/"), "phase-1.md": notes("**Plan change:** add a phase first"), "phase-2.md": PHASE([false]) },
|
|
applied: { "overview.md": checklist("/"), "phase-1.md": notes("**Plan change (applied 2026-10-27):** add a phase first"), "phase-2.md": PHASE([false]) },
|
|
dropped: { "overview.md": checklist("/"), "phase-1.md": notes("**Plan change (dropped 2026-10-27):** add a phase first"), "phase-2.md": PHASE([false]) },
|
|
// No phase marked [/]: every phase file is read.
|
|
unmarked: { "overview.md": checklist(" "), "phase-1.md": PHASE([false]), "phase-2.md": notes("**Plan change:** rename a task") },
|
|
// A brief in a phase that is not the one in progress is not waiting on it.
|
|
otherPhase: { "overview.md": checklist("/"), "phase-1.md": notes("Nothing to change."), "phase-2.md": notes("**Plan change:** later") },
|
|
// Outside the Notes section it is only prose.
|
|
notInNotes: { "overview.md": checklist("/"), "phase-1.md": "# Phase 1\n\n**Plan change:** quoted in the overview\n\n- [ ] **Task 1.1:** One\n", "phase-2.md": PHASE([false]) },
|
|
built: { "overview.md": checklist("x"), "phase-1.md": notes("**Plan change:** found in the last checks").replace("- [ ] **Task 1.2:**", "- [x] **Task 1.2:**"), "phase-2.md": PHASE([true]) },
|
|
planned: { "PLAN-DRAFT-20261027.md": "# Plan draft\n\n**Status:** Draft\n\n## Notes\n\n**Plan change:** not a phased spec\n" },
|
|
};
|
|
try {
|
|
for (const [name, files] of Object.entries(specs))
|
|
for (const [rel, text] of Object.entries(files)) {
|
|
fs.mkdirSync(path.join(root, "specs", name), { recursive: true });
|
|
fs.writeFileSync(path.join(root, "specs", name, rel), text);
|
|
}
|
|
const by = Object.fromEntries(scanProject(root).specs.map((sp) => [sp.name, sp]));
|
|
assert.equal(by.waiting.planChange, true);
|
|
assert.equal(by.waiting.state, "building");
|
|
assert.equal("planChange" in by.applied, false);
|
|
assert.equal("planChange" in by.dropped, false);
|
|
assert.equal(by.unmarked.planChange, true);
|
|
assert.equal(by.unmarked.state, "building");
|
|
assert.equal("planChange" in by.otherPhase, false);
|
|
assert.equal("planChange" in by.notInNotes, false);
|
|
assert.equal(by.built.state, "built");
|
|
assert.equal(by.built.planChange, true, "a built spec can still have a brief waiting");
|
|
assert.equal("planChange" in by.planned, false);
|
|
} finally {
|
|
fs.rmSync(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
// The states no card names in its `states` list: a card that is on for "any"
|
|
// spec does not count, since it would take a state nobody thought about. A
|
|
// finished state is taken by no card on purpose.
|
|
function untakenStates(skills, table) {
|
|
const taken = new Set(skills.flatMap((sk) => (Array.isArray(sk.states) ? sk.states : [])));
|
|
return Object.entries(table)
|
|
.filter(([name, s]) => !s.finished && !taken.has(name))
|
|
.map(([name]) => `no card's states take ${name}: add it to the skills.js entries whose card it lights`);
|
|
}
|
|
|
|
test("card rules: every state still in play is taken by at least one card", () => {
|
|
assert.deepEqual(untakenStates(SKILLS, TABLE), []);
|
|
// The check names the state: Document and Plan are the cards that take planned.
|
|
const without = SKILLS.map((sk) =>
|
|
Array.isArray(sk.states) && (sk.skill === "plan2code-2-document" || sk.skill === "plan2code-1-plan")
|
|
? { ...sk, states: sk.states.filter((st) => st !== "planned") }
|
|
: sk
|
|
);
|
|
assert.deepEqual(untakenStates(without, TABLE), ["no card's states take planned: add it to the skills.js entries whose card it lights"]);
|
|
});
|
|
|
|
test("card rules: a card's states and grayed reasons name only real states", () => {
|
|
const known = new Set([...Object.keys(TABLE), "none"]);
|
|
for (const sk of SKILLS) {
|
|
if (Array.isArray(sk.states)) for (const st of sk.states) assert.ok(known.has(st), `${sk.skill} takes ${st}, which is no state`);
|
|
for (const key of Object.keys(sk.greyed || {})) assert.ok(key === "default" || key === "finished" || known.has(key), `${sk.skill}'s grayed names ${key}, which is no state`);
|
|
if (Array.isArray(sk.states) && sk.card) assert.ok(sk.greyed && sk.greyed.default, `${sk.skill} has a default grayed reason`);
|
|
}
|
|
});
|
|
|
|
// The states the dashboard skill's prose (src/plan2code.md) never mentions,
|
|
// by name in backticks (`planned`) or by label in quotes ("Ready to
|
|
// document"). The agent reads that prose to choose its recommendation, so
|
|
// every state needs a word there; a bare word ("reading or exploring", a file
|
|
// named building-habits.md) is not one.
|
|
function unmentionedStates(prose, table) {
|
|
const lower = prose.toLowerCase();
|
|
return Object.entries(table)
|
|
.filter(([name, s]) => !prose.includes("`" + name + "`") && !lower.includes(`"${s.label.toLowerCase()}"`))
|
|
.map(([name, s]) => `src/plan2code.md mentions neither \`${name}\` nor "${s.label}"`);
|
|
}
|
|
|
|
test("the dashboard skill: its prose names every spec state", () => {
|
|
const prose = fs.readFileSync(path.join(import.meta.dirname, "..", "src", "plan2code.md"), "utf8");
|
|
assert.deepEqual(unmentionedStates(prose, TABLE), []);
|
|
const sample = 'Only `planned` and "Ready to build", while building and exploring are bare words.';
|
|
const some = { planned: TABLE.planned, documented: TABLE.documented, building: TABLE.building, exploring: TABLE.exploring };
|
|
assert.deepEqual(unmentionedStates(sample, some), [
|
|
'src/plan2code.md mentions neither `building` nor "Building"',
|
|
'src/plan2code.md mentions neither `exploring` nor "Exploring"',
|
|
]);
|
|
});
|