// lib/validators/brief-validator.mjs // Validate trekbrief frontmatter + body invariants. // // Schema is forward-compatible: unknown top-level frontmatter keys are // tolerated silently. Strict-key checks are intentionally avoided so new // optional fields (jf. the source_findings precedent on trekreview) can be // added without a brief_version bump. import { readFileSync, existsSync } from 'node:fs'; import { parseDocument } from '../util/frontmatter.mjs'; import { issue, ok, fail } from '../util/result.mjs'; import { BASE_ALLOWED_MODELS } from './profile-validator.mjs'; export const BRIEF_REQUIRED_FRONTMATTER = ['type', 'brief_version', 'task', 'slug', 'research_topics', 'research_status']; export const REVIEW_AS_BRIEF_REQUIRED_FRONTMATTER = ['type', 'task', 'slug', 'project_dir', 'findings']; export const BRIEF_TYPE_VALUES = Object.freeze(['trekbrief', 'trekreview']); export const BRIEF_RESEARCH_STATUS_VALUES = ['pending', 'in_progress', 'complete', 'skipped']; export const BRIEF_BODY_SECTIONS = ['Intent', 'Goal', 'Success Criteria']; export const PHASE_SIGNAL_PHASES = Object.freeze(['research', 'plan', 'execute', 'review']); export const EFFORT_LEVELS = Object.freeze(['low', 'standard', 'high']); // v5.5 — framing: how this brief relates to prior operator intent (the first layer // of the framing-alignment defense). Required at brief_version ≥ 2.2. export const BRIEF_FRAMING_VALUES = Object.freeze(['preserve', 'refine', 'replace', 'new-direction']); // v5.5 — obligatory TL;DR section (≤ 5 content lines) at the top of brief.md, // gated at brief_version ≥ 2.2. Soft cap is a warning, not a blocker. export const BRIEF_TLDR_MAX_LINES = 5; // Extract the raw text of a `## {heading}` section body (between its heading line // and the next `## ` heading, or end of document). Returns null if absent. function extractSection(body, heading) { const re = new RegExp(`^##\\s+${heading}\\b.*$`, 'm'); const m = re.exec(body); if (!m) return null; const after = body.slice(m.index + m[0].length); const next = after.search(/^##\s/m); return next === -1 ? after : after.slice(0, next); } function getRequiredFields(type) { return type === 'trekreview' ? REVIEW_AS_BRIEF_REQUIRED_FRONTMATTER : BRIEF_REQUIRED_FRONTMATTER; } export function validateBriefContent(text, opts = {}) { const strict = opts.strict !== false; const doc = parseDocument(text); if (!doc.valid) return doc; const fm = doc.parsed.frontmatter || {}; const body = doc.parsed.body || ''; const errors = []; const warnings = []; for (const k of getRequiredFields(fm.type)) { if (!(k in fm)) { errors.push(issue('BRIEF_MISSING_FIELD', `Required frontmatter field missing: ${k}`)); } } // v5.1 — phase_signals (additive optional field) + version-conditional sequencing gate. // Composition rule documented in each downstream command's "Composition rule (v5.1)" section. const hasSignals = 'phase_signals' in fm; const hasPartial = 'phase_signals_partial' in fm; if (hasSignals && hasPartial) { errors.push(issue( 'BRIEF_SIGNALS_MUTUALLY_EXCLUSIVE', 'phase_signals and phase_signals_partial are mutually exclusive — set exactly one', 'Either commit per-phase signals OR record phase_signals_partial: true (force-stop).', )); } if (hasSignals) { if (!Array.isArray(fm.phase_signals)) { errors.push(issue( 'BRIEF_INVALID_PHASE_SIGNALS', 'phase_signals must be a list of {phase, effort?, model?} entries', )); } else { for (const entry of fm.phase_signals) { if (!entry || typeof entry !== 'object' || !('phase' in entry)) { errors.push(issue('BRIEF_INVALID_PHASE_SIGNALS', `phase_signals entry must include a "phase" key`)); continue; } if (!PHASE_SIGNAL_PHASES.includes(entry.phase)) { errors.push(issue( 'BRIEF_INVALID_PHASE_SIGNAL_PHASE', `phase_signals.phase "${entry.phase}" not in [${PHASE_SIGNAL_PHASES.join(', ')}]`, )); } if ('effort' in entry && !EFFORT_LEVELS.includes(entry.effort)) { errors.push(issue( 'BRIEF_INVALID_EFFORT', `phase_signals.effort "${entry.effort}" not in [${EFFORT_LEVELS.join(', ')}]`, )); } if ('model' in entry && !BASE_ALLOWED_MODELS.includes(entry.model)) { errors.push(issue( 'BRIEF_INVALID_MODEL', `phase_signals.model "${entry.model}" not in [${BASE_ALLOWED_MODELS.join(', ')}]`, )); } } } } // Sequencing gate: brief_version ≥ 2.1 requires phase_signals OR phase_signals_partial. // Coerce to String so the gate fires regardless of whether YAML parsed the value as // a string ("2.1") or a number (2.1). v5.1.0 shipped with an unquoted-2.1 template // that silently bypassed this gate — fix locked in by quoting the template AND // accepting both shapes here as defense-in-depth (v5.1.1, finding 3c834097/df1435a2). // v5.5 — framing enum check fires on ANY version when the field is present but // malformed. The missing-framing BLOCKER below is version-gated (≥ 2.2). if ('framing' in fm && !BRIEF_FRAMING_VALUES.includes(fm.framing)) { errors.push(issue( 'BRIEF_INVALID_FRAMING', `framing "${fm.framing}" not in [${BRIEF_FRAMING_VALUES.join(', ')}]`, 'framing declares how this brief relates to prior operator intent.', )); } if (typeof fm.brief_version === 'string' || typeof fm.brief_version === 'number') { const vm = String(fm.brief_version).match(/^(\d+)\.(\d+)$/); if (vm) { const major = Number(vm[1]); const minor = Number(vm[2]); const atLeast21 = major > 2 || (major === 2 && minor >= 1); const atLeast22 = major > 2 || (major === 2 && minor >= 2); if (atLeast21 && !hasSignals && !hasPartial && fm.type !== 'trekreview') { errors.push(issue( 'BRIEF_V51_MISSING_SIGNALS', 'brief_version ≥ 2.1 requires phase_signals (or phase_signals_partial: true)', 'Re-run /trekbrief — Phase 3.5 collects per-phase effort + model signals.', )); } // v5.5 framing enforcement — gated at ≥ 2.2 (trekreview briefs are exempt). if (atLeast22 && fm.type !== 'trekreview') { if (!('framing' in fm)) { errors.push(issue( 'BRIEF_MISSING_FRAMING', 'brief_version ≥ 2.2 requires a framing: field', `Set framing to one of [${BRIEF_FRAMING_VALUES.join(', ')}] — /trekbrief Phase 2.5 collects it before any brief prose is written.`, )); } const tldr = extractSection(body, 'TL;DR'); if (tldr === null) { const tldrIssue = issue('BRIEF_MISSING_SECTION', 'Required body section missing: ## TL;DR'); if (strict) errors.push(tldrIssue); else warnings.push(tldrIssue); } else { const lines = tldr.split('\n').map(l => l.trim()).filter(Boolean); if (lines.length > BRIEF_TLDR_MAX_LINES) { warnings.push(issue( 'BRIEF_TLDR_TOO_LONG', `## TL;DR has ${lines.length} content lines (max ${BRIEF_TLDR_MAX_LINES}) — keep it to a one-glance summary`, )); } } } } } // S18 — opt-in version floor. When the caller passes minBriefVersion (commands // forward --min-brief-version), WARN (never block) if the brief declares a // version below it: framing enforcement only fires at ≥ 2.2, so an older brief // sidesteps the framing-alignment defense silently. Absent opt → no check. // trekreview briefs have no framing and are exempt. if (opts.minBriefVersion && fm.type !== 'trekreview') { const mm = String(opts.minBriefVersion).match(/^(\d+)\.(\d+)$/); if (mm) { const minMajor = Number(mm[1]); const minMinor = Number(mm[2]); const bm = fm.brief_version === undefined ? null : String(fm.brief_version).match(/^(\d+)\.(\d+)$/); const below = bm ? (Number(bm[1]) < minMajor || (Number(bm[1]) === minMajor && Number(bm[2]) < minMinor)) : true; // absent or unparseable version is below any floor if (below) { warnings.push(issue( 'BRIEF_VERSION_BELOW_MINIMUM', `brief_version ${fm.brief_version ?? '(absent)'} is below the requested minimum ${opts.minBriefVersion} — framing enforcement (≥ 2.2) is bypassed`, 'Re-run /trekbrief to produce a brief_version 2.2 brief, or drop --min-brief-version to accept the older brief as-is.', )); } } } if (fm.type !== undefined && !BRIEF_TYPE_VALUES.includes(fm.type)) { errors.push(issue( 'BRIEF_WRONG_TYPE', `frontmatter.type must be one of [${BRIEF_TYPE_VALUES.join(', ')}], got "${fm.type}"`, )); } if (fm.type === 'trekreview' && fm.findings !== undefined && !Array.isArray(fm.findings)) { errors.push(issue( 'BRIEF_BAD_FINDINGS_TYPE', 'Field "findings" must be an array of finding-IDs for type:trekreview', 'Use block-style YAML: `findings:\\n - \\n - `', )); } if (fm.research_status !== undefined && !BRIEF_RESEARCH_STATUS_VALUES.includes(fm.research_status)) { errors.push(issue( 'BRIEF_BAD_STATUS', `research_status "${fm.research_status}" not in [${BRIEF_RESEARCH_STATUS_VALUES.join(', ')}]`, )); } if (typeof fm.research_topics === 'number' && fm.research_topics > 0 && fm.research_status === 'skipped') { if (fm.brief_quality !== 'partial') { errors.push(issue( 'BRIEF_STATE_INCOHERENT', `research_topics=${fm.research_topics} but research_status=skipped`, 'Either set research_status to a real progress value, or mark brief_quality: partial.', )); } else { warnings.push(issue( 'BRIEF_PARTIAL_SKIPPED', `Brief has unresolved research topics (${fm.research_topics}) but is partial`, )); } } for (const section of BRIEF_BODY_SECTIONS) { const re = new RegExp(`^##\\s+${section}\\b`, 'm'); if (!re.test(body)) { const issueObj = issue('BRIEF_MISSING_SECTION', `Required body section missing: ## ${section}`); if (strict) errors.push(issueObj); else warnings.push(issueObj); } } if (typeof fm.brief_version === 'string' || typeof fm.brief_version === 'number') { const m = String(fm.brief_version).match(/^(\d+)\.(\d+)$/); if (!m) { warnings.push(issue('BRIEF_VERSION_FORMAT', `brief_version "${fm.brief_version}" not in N.M form`)); } } return { valid: errors.length === 0, errors, warnings, parsed: { frontmatter: fm, body } }; } export function validateBrief(filePath, opts = {}) { if (!existsSync(filePath)) return fail(issue('BRIEF_NOT_FOUND', `File not found: ${filePath}`)); let text; try { text = readFileSync(filePath, 'utf-8'); } catch (e) { return fail(issue('BRIEF_READ_ERROR', `Cannot read ${filePath}: ${e.message}`)); } const r = validateBriefContent(text, opts); return { ...r, parsed: { ...r.parsed, filePath } }; } if (import.meta.url === `file://${process.argv[1]}`) { const args = process.argv.slice(2); const strict = !args.includes('--soft'); const minIdx = args.indexOf('--min-version'); const minBriefVersion = minIdx >= 0 ? args[minIdx + 1] : undefined; // filePath is the first positional, skipping the --min-version value token. const filePath = args.find((a, i) => !a.startsWith('--') && i !== minIdx + 1); if (!filePath) { process.stderr.write('Usage: brief-validator.mjs [--soft] [--min-version ] \n'); process.exit(2); } const r = validateBrief(filePath, { strict, minBriefVersion }); if (args.includes('--json')) { process.stdout.write(JSON.stringify({ valid: r.valid, errors: r.errors, warnings: r.warnings }, null, 2) + '\n'); } else { process.stdout.write(`brief-validator: ${r.valid ? 'PASS' : 'FAIL'} ${filePath}\n`); for (const e of r.errors) process.stderr.write(` ERROR [${e.code}] ${e.message}\n`); for (const w of r.warnings) process.stderr.write(` WARN [${w.code}] ${w.message}\n`); } process.exit(r.valid ? 0 : 1); }