The plan template (templates/plan-template.md:21) emits plan_version ONLY in
the prose blockquote metadata line:
> Generated by trekplan v{version} on {YYYY-MM-DD} — `plan_version: 1.7`
It carries no frontmatter plan_version (the frontmatter block is trekreview-only
and holds source_findings). But PLAN_VERSION_REGEX in lib/parsers/plan-schema.mjs
was `^`-anchored (/m), matching ONLY line-start (frontmatter). The backtick-
wrapped prose form never matched → extractPlanVersion returned null → every real
generated plan got a spurious PLAN_NO_VERSION warning from plan-validator.
Not caught earlier because no test ran the parser against the actual template;
the synthetic fixtures all carry frontmatter plan_version and parse fine.
Internal source contradiction surfaced: the parser comment documents intent
"frontmatter OR doc body", planning-orchestrator.md:228 + the template place it
in the prose line, while HANDOVER-CONTRACTS.md calls it a frontmatter field.
Operator-chosen fix (parser, not template): relax the regex to
`/(?:^|`)plan_version:.../m` so it matches line-start (frontmatter) OR the
backtick-prefixed prose form. Honors the parser's own documented contract,
fixes all existing + future plans, changes no plan output, touches one code
file — vs the template-fix which would alter every plan's shape, contradict
planning-orchestrator.md, and force a 3-file doc reconciliation (scope creep).
TDD (red first): added prose-form + canonical-template regression pins in
plan-schema.test.mjs and a no-PLAN_NO_VERSION pin in plan-validator.test.mjs;
all 3 red on the `^`-anchored regex, green after the relax. The template pin
ties the parser directly to the real generated artifact.
S22 defect closed in docs/S22-happy-path-dogfood.md (§Pipeline defects + log).
Tests: 728 (726 pass / 2 skip / 0 fail; live `node --test`, = 725 baseline +3).
plugin validate passes (1 accepted CLAUDE.md-at-root warning).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LqBYc8Ltrk7LipyJmGxXiB
129 lines
4.4 KiB
JavaScript
129 lines
4.4 KiB
JavaScript
// lib/parsers/plan-schema.mjs
|
|
// Plan v1.7 schema parser — heading shape detection.
|
|
//
|
|
// The canonical step heading is `### Step N: <title>` (literal colon-space).
|
|
// Forbidden narrative drift formats (introduced in v1.8.0 to defend against
|
|
// Opus 4.7 schema-drift): `## Fase N`, `### Phase N`, `### Stage N`, `### Steg N`.
|
|
//
|
|
// This module extracts step boundaries; per-step body parsing lives elsewhere.
|
|
|
|
import { ok, fail, issue } from '../util/result.mjs';
|
|
|
|
export const STEP_HEADING_REGEX = /^### Step (\d+):\s+(.+?)\s*$/m;
|
|
export const STEP_HEADING_GLOBAL = /^### Step (\d+):\s+(.+?)\s*$/gm;
|
|
export const FORBIDDEN_HEADING_REGEX = /^(?:##|###) (?:Fase|Phase|Stage|Steg) \d+/m;
|
|
export const FORBIDDEN_HEADING_GLOBAL = /^(?:##|###) (?:Fase|Phase|Stage|Steg) \d+/gm;
|
|
// Matches plan_version in either location the schema allows: at line start
|
|
// (frontmatter) or backtick-wrapped inside the prose "Generated by" metadata
|
|
// line the plan template emits (`> Generated by ... — `plan_version: 1.7``).
|
|
export const PLAN_VERSION_REGEX = /(?:^|`)plan_version:\s*['"]?([\d.]+)['"]?/m;
|
|
|
|
/**
|
|
* Find all step heading positions in plan text.
|
|
* @returns {Array<{n: number, title: string, line: number, offset: number}>}
|
|
*/
|
|
export function findSteps(text) {
|
|
if (typeof text !== 'string') return [];
|
|
const out = [];
|
|
STEP_HEADING_GLOBAL.lastIndex = 0;
|
|
let m;
|
|
while ((m = STEP_HEADING_GLOBAL.exec(text)) !== null) {
|
|
const offset = m.index;
|
|
const line = text.slice(0, offset).split(/\r?\n/).length;
|
|
out.push({ n: Number.parseInt(m[1], 10), title: m[2].trim(), line, offset });
|
|
}
|
|
return out;
|
|
}
|
|
|
|
/**
|
|
* Find forbidden narrative-drift heading occurrences (Fase/Phase/Stage/Steg N).
|
|
* @returns {Array<{form: string, line: number, offset: number, raw: string}>}
|
|
*/
|
|
export function findForbiddenHeadings(text) {
|
|
if (typeof text !== 'string') return [];
|
|
const out = [];
|
|
FORBIDDEN_HEADING_GLOBAL.lastIndex = 0;
|
|
let m;
|
|
while ((m = FORBIDDEN_HEADING_GLOBAL.exec(text)) !== null) {
|
|
const offset = m.index;
|
|
const line = text.slice(0, offset).split(/\r?\n/).length;
|
|
const raw = m[0];
|
|
out.push({ form: raw, line, offset, raw });
|
|
}
|
|
return out;
|
|
}
|
|
|
|
/**
|
|
* Slice plan text into per-step sections.
|
|
* @returns {Array<{n: number, title: string, body: string, line: number}>}
|
|
*/
|
|
export function sliceSteps(text) {
|
|
const heads = findSteps(text);
|
|
const sections = [];
|
|
for (let i = 0; i < heads.length; i++) {
|
|
const start = heads[i].offset;
|
|
const end = i + 1 < heads.length ? heads[i + 1].offset : text.length;
|
|
const block = text.slice(start, end);
|
|
sections.push({
|
|
n: heads[i].n,
|
|
title: heads[i].title,
|
|
body: block,
|
|
line: heads[i].line,
|
|
});
|
|
}
|
|
return sections;
|
|
}
|
|
|
|
/**
|
|
* Extract `plan_version: X.Y` from frontmatter or doc body.
|
|
*/
|
|
export function extractPlanVersion(text) {
|
|
const m = typeof text === 'string' ? text.match(PLAN_VERSION_REGEX) : null;
|
|
return m ? m[1] : null;
|
|
}
|
|
|
|
/**
|
|
* Validate plan structure at the heading level.
|
|
* Strict mode: forbidden-heading count > 0 → error. Step numbers must be 1..N contiguous.
|
|
* @returns {import('../util/result.mjs').Result}
|
|
*/
|
|
export function validatePlanHeadings(text, opts = {}) {
|
|
const strict = opts.strict !== false;
|
|
const errors = [];
|
|
const warnings = [];
|
|
|
|
if (typeof text !== 'string') {
|
|
return fail(issue('PLAN_INPUT', 'Plan text is not a string'));
|
|
}
|
|
|
|
const forbidden = findForbiddenHeadings(text);
|
|
if (forbidden.length > 0) {
|
|
const list = forbidden.map(f => `line ${f.line}: ${f.raw}`).join('; ');
|
|
const errorIssue = issue(
|
|
'PLAN_FORBIDDEN_HEADING',
|
|
`Found ${forbidden.length} forbidden narrative-drift heading(s): ${list}`,
|
|
'Use canonical "### Step N: <title>". Forbidden forms: Fase/Phase/Stage/Steg.',
|
|
);
|
|
if (strict) errors.push(errorIssue);
|
|
else warnings.push(errorIssue);
|
|
}
|
|
|
|
const steps = findSteps(text);
|
|
if (steps.length === 0) {
|
|
errors.push(issue('PLAN_NO_STEPS', 'No step headings found', 'Expected at least one "### Step 1: <title>".'));
|
|
} else {
|
|
const numbers = steps.map(s => s.n);
|
|
for (let i = 0; i < numbers.length; i++) {
|
|
if (numbers[i] !== i + 1) {
|
|
errors.push(issue(
|
|
'PLAN_STEP_NUMBERING',
|
|
`Step numbering breaks at position ${i + 1} (got Step ${numbers[i]})`,
|
|
'Steps must be 1..N contiguous and ordered.',
|
|
));
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return { valid: errors.length === 0, errors, warnings, parsed: { steps, forbidden } };
|
|
}
|