/** * Enforce `wc -w`-style ceilings from `scripts/doc-budgets.manifest.json`. * Missing files and invalid ceilings fail; `--list` reports current usage. * Only listed standing docs are budgeted. Ceilings ratchet down with at least * 5% headroom; raising one requires the justification defined in * `docs/AGENTS.md`. */ import { existsSync, readFileSync } from 'node:fs' import { resolve } from 'node:path' const root = resolve(import.meta.dirname, '..') const MANIFEST_PATH = resolve(root, 'scripts/doc-budgets.manifest.json') /** `wc -w` equivalent: count whitespace-delimited tokens. */ function countWords(text: string): number { return text.split(/\s+/).filter(Boolean).length } const manifest = JSON.parse(readFileSync(MANIFEST_PATH, 'utf8')) as Record const listOnly = process.argv.includes('--list') const failures: string[] = [] const rows: string[] = [] for (const [path, ceiling] of Object.entries(manifest)) { if (!Number.isInteger(ceiling) || ceiling <= 0) { rows.push(`BAD ${'—'.padStart(6)} / ${String(ceiling).padEnd(6)} ${path}`) failures.push(`${path}: ceiling must be a positive integer, got ${ceiling}`) continue } const abs = resolve(root, path) if (!existsSync(abs)) { rows.push(`MISS ${'—'.padStart(6)} / ${String(ceiling).padEnd(6)} ${path}`) failures.push(`${path}: budgeted file does not exist (renamed or deleted? update scripts/doc-budgets.manifest.json in the same change)`) continue } const words = countWords(readFileSync(abs, 'utf8')) rows.push(`${words <= ceiling ? 'ok ' : 'OVER'} ${String(words).padStart(6)} / ${String(ceiling).padEnd(6)} ${path}`) if (words > ceiling) { failures.push(`${path}: ${words} words exceeds the ${ceiling}-word ceiling — relocate or condense per docs/AGENTS.md (raising the ceiling requires justification in the PR)`) } } if (listOnly) { console.log(rows.join('\n')) process.exit(0) } if (failures.length > 0) { console.error('verify-doc-budgets failed:\n') for (const failure of failures) console.error(` ${failure}`) console.error('\nSee docs/AGENTS.md for the documentation standard and the relocation-first rule.') process.exit(1) } console.log(`verify-doc-budgets: ${Object.keys(manifest).length} budgeted docs within ceiling.`)