Files
msd-core/scripts/strip-prose-atrefs.cjs
Tom Boucher 81f9534b5a feat(adr-0002): command contract validation module + prose @-ref cleanup + workflow extraction
ADR-0002: commands/gsd/*.md contract now enforced at two layers:

LINT (scripts/lint-command-contract.cjs — new CI step):
- name: present, starts with gsd: or gsd-
- description: non-empty
- allowed-tools: non-empty, all entries canonical
- execution_context @-refs: resolve on disk, no trailing prose on same line
- handles both @~/ and $HOME/ path prefixes

TEST (tests/command-contract.test.cjs — 361 assertions):
- Behavioral contract for all 65 command files
- Replaces scattered coverage in enh-2790 + bug-3135
- Per-command per-rule test — one failure names the exact file + rule

CI (.github/workflows/test.yml):
- 'Lint — command contract (ADR-0002)' step added to lint-tests job

PROSE @-REF CLEANUP (39 command files, ~900 tokens/invocation recovered):
- Removed redundant @~/.claude/get-shit-done/... paths from <process> prose
- execution_context block is now the single authoritative load declaration
- Routing commands (sketch, spike, update, pause-work, etc.) keep routing
  instructions; only the inert path token is stripped

WORKFLOW EXTRACTION (debug.md + thread.md, ~15,000 chars / ~3,750 tokens):
- get-shit-done/workflows/debug.md: full process extracted from commands/gsd/debug.md
- get-shit-done/workflows/thread.md: full process extracted from commands/gsd/thread.md
- Command files reduced to frontmatter + objective + execution_context + context
- debug.md: 9,603 → 1,703 chars; thread.md: 7,868 → 585 chars

RENAME:
- get-shit-done/workflows/extract_learnings.md → extract-learnings.md
  (aligns with hyphen convention of all other workflow files)

DOCS:
- docs/INVENTORY.md: count 85→87, new rows, rename row, fix add-todo --backlog attribution
- docs/INVENTORY-MANIFEST.json: +debug.md +thread.md +extract-learnings.md -extract_learnings.md

Closes ADR-0002 implementation.
2026-05-05 15:18:13 -04:00

106 lines
3.8 KiB
JavaScript

#!/usr/bin/env node
/**
* strip-prose-atrefs.cjs
*
* Removes redundant @~/.claude/get-shit-done/ path tokens from prose lines
* in <process> and <context> blocks. The path is already declared in
* <execution_context> where it actually loads the file. Prose copies are
* inert and add ~900 tokens/invocation of dead weight.
*
* Transformation rules (applied per matching line):
* - "Execute the X workflow from @PATH end-to-end." → "Execute end-to-end."
* - "Execute @PATH end-to-end." → "Execute end-to-end."
* - "Read and execute the X workflow from @PATH end-to-end." → "Execute end-to-end."
* - "Follow the X workflow at @PATH." → "Execute end-to-end."
* - "Output the X reference from @PATH." → "Execute end-to-end."
* - "**Follow the X** from `@PATH`." → "**Follow the X.**"
* - "- If it is '...': ... from @PATH end-to-end." → strip path token only
* - "- Otherwise: ... from @PATH end-to-end." → strip path token only
* - "- @PATH (label)" → "- (label)"
*
* Run with --dry-run to preview without writing.
*/
'use strict';
const fs = require('fs');
const path = require('path');
const DRY_RUN = process.argv.includes('--dry-run');
const ROOT = path.join(__dirname, '..');
const COMMANDS_DIR = path.join(ROOT, 'commands', 'gsd');
const AT_PATH_RE = /@(?:~|\$HOME)\/.+?get-shit-done\/[^\s`\)]+/g;
function transformLine(line) {
if (!AT_PATH_RE.test(line)) return line;
AT_PATH_RE.lastIndex = 0;
const trimmed = line.trim();
// "- @PATH (label)" → "- (label)"
if (/^- @(?:~|\$HOME)\//.test(trimmed)) {
return line.replace(/^(\s*- )@(?:~|\$HOME)\/[^\s(]+\s*/, '$1');
}
// "**Follow the X workflow** from `@PATH`." → "**Follow the X workflow.**"
// "**Follow the X workflow** from `@PATH`" → "**Follow the X workflow.**"
if (/\*\*Follow the .+ workflow\*\* from `@/.test(trimmed)) {
return line.replace(/\s+from `@(?:~|\$HOME)\/[^`]+`\.?/, '.');
}
// Routing bullet: keep everything except "from @PATH" or bare "@PATH"
// "- If …: … from @PATH end-to-end." → strip path, keep bullet
// "- Otherwise: … from @PATH end-to-end." → strip path, keep bullet
if (/^- (?:If |Otherwise:|pass all)/.test(trimmed)) {
return line
.replace(/\s+from\s+@(?:~|\$HOME)\/\S+/g, '')
.replace(/@(?:~|\$HOME)\/\S+/g, '');
}
// "Execute [the X workflow] [from] @PATH [end-to-end]."
// "Read and execute …" / "Follow …" / "Output …"
// → collapse to leading indent + "Execute end-to-end."
const indent = line.match(/^(\s*)/)[1];
return `${indent}Execute end-to-end.`;
}
function processFile(filePath) {
const original = fs.readFileSync(filePath, 'utf-8');
const lines = original.split('\n');
const out = [];
let inProse = false; // true when inside <process> or <context> (not execution_context)
for (const line of lines) {
const t = line.trim();
if (/<(process|context)>/.test(t) && !t.includes('execution_context')) inProse = true;
if (/<\/(process|context)>/.test(t) && !t.includes('execution_context')) inProse = false;
if (inProse && AT_PATH_RE.test(line)) {
AT_PATH_RE.lastIndex = 0;
out.push(transformLine(line));
} else {
out.push(line);
}
}
const result = out.join('\n');
if (result === original) return false; // no change
if (!DRY_RUN) fs.writeFileSync(filePath, result, 'utf-8');
return true;
}
const files = fs.readdirSync(COMMANDS_DIR)
.filter(f => f.endsWith('.md'))
.map(f => path.join(COMMANDS_DIR, f));
let changed = 0;
for (const f of files) {
if (processFile(f)) {
console.log(`${DRY_RUN ? '[dry]' : 'fixed'}: ${path.basename(f)}`);
changed++;
}
}
console.log(`\n${changed} file(s) ${DRY_RUN ? 'would be' : 'were'} modified.`);