mirror of
https://github.com/glittercowboy/get-shit-done
synced 2026-05-15 11:36:37 +02:00
* feat(#2982): extend no-source-grep lint to catch var-binding readFileSync.includes() The base lint (scripts/lint-no-source-grep.cjs) only catches readFileSync(...).<text-method>() chained directly. The much more common var-binding form escapes it: const src = fs.readFileSync(p, 'utf8'); // 50 lines later if (src.includes('foo')) {} // ← still grep, lint missed it Scan of the test suite found ~141 files using this pattern. Implementation built TDD per #2982 with structured-IR assertions: scripts/lint-no-source-grep-extras.cjs - detectVarBindingViolations(src) — pure detector, two passes: pass 1 collects vars bound from readFileSync, pass 2 finds any <var>.<includes|startsWith|endsWith|match|search>( on those vars. - detectWrappedAssertOkMatch(src) — flags assert.ok(<expr>.match(...)) which escapes the assert.match rule. - VIOLATION enum exposes stable codes for tests to assert on. scripts/lint-no-source-grep.cjs - Wires the new detectors into the existing per-file check; one additional violation row per file with the first 3 sample tokens. tests/bug-2982-lint-var-binding.test.cjs - 13 tests, all assertions on typed VIOLATION enum / structured records. Covers all 5 text-match methods, multi-var, no-bind, string literal (must NOT trigger), wrapped assert.ok(.match), and assert.match (must NOT double-flag). Migration backlog (#2974 expanded scope): - 42 files annotated `// allow-test-rule: source-text-is-the-product` (legitimate — they read .md/.json/.yml files whose deployed text IS the product) - 3 files annotated `// allow-test-rule: pending-migration-to-typed-ir [#2974]` (read .cjs/.js source — clear migration debt) - 95 files annotated `pending-migration-to-typed-ir [#2974]` with `Per-file review may reclassify as source-text-is-the-product during migration` (mixed — manual review under #2974) After this lands the lint reports 0 violations on main; new violations in PRs surface immediately. Closes #2982 Refs #2974 * test(#2982): fix truncated test name per CR The label ended with a bare '(' from a copy-paste mishap. Now reads 'does NOT flag .matchAll(...) — matchAll is not match, so assert.ok(.matchAll(...)) is not flagged'. * chore(#2982): add changeset fragment for PR #2985 * chore(#2982): add changeset fragment for PR #2985
192 lines
7.5 KiB
JavaScript
192 lines
7.5 KiB
JavaScript
// allow-test-rule: pending-migration-to-typed-ir [#2974]
|
|
// Tracked in #2974 for migration to typed-IR assertions per CONTRIBUTING.md
|
|
// "Prohibited: Raw Text Matching on Test Outputs". Per-file review may
|
|
// reclassify some entries as source-text-is-the-product during migration.
|
|
|
|
/**
|
|
* Template Tests
|
|
*
|
|
* Tests for cmdTemplateSelect (heuristic template selection) and
|
|
* cmdTemplateFill (summary, plan, verification template generation).
|
|
*/
|
|
|
|
const { test, describe, beforeEach, afterEach } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const { runGsdTools, createTempProject, cleanup } = require('./helpers.cjs');
|
|
|
|
// ─── template select ──────────────────────────────────────────────────────────
|
|
|
|
describe('template select command', () => {
|
|
let tmpDir;
|
|
|
|
beforeEach(() => {
|
|
tmpDir = createTempProject();
|
|
// Create a phase directory with a plan
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-setup');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
});
|
|
|
|
afterEach(() => {
|
|
cleanup(tmpDir);
|
|
});
|
|
|
|
test('selects minimal template for simple plan', () => {
|
|
const planPath = path.join(tmpDir, '.planning', 'phases', '01-setup', '01-01-PLAN.md');
|
|
fs.writeFileSync(planPath, [
|
|
'# Plan',
|
|
'',
|
|
'### Task 1',
|
|
'Do the thing.',
|
|
'',
|
|
'File: `src/index.ts`',
|
|
].join('\n'));
|
|
|
|
const result = runGsdTools(`template select .planning/phases/01-setup/01-01-PLAN.md`, tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.type, 'minimal');
|
|
assert.ok(out.template.includes('summary-minimal'));
|
|
});
|
|
|
|
test('selects standard template for moderate plan', () => {
|
|
const planPath = path.join(tmpDir, '.planning', 'phases', '01-setup', '01-01-PLAN.md');
|
|
fs.writeFileSync(planPath, [
|
|
'# Plan',
|
|
'',
|
|
'### Task 1',
|
|
'Create `src/auth/login.ts`',
|
|
'',
|
|
'### Task 2',
|
|
'Create `src/auth/register.ts`',
|
|
'',
|
|
'### Task 3',
|
|
'Update `src/routes/index.ts`',
|
|
'',
|
|
'Files: `src/auth/login.ts`, `src/auth/register.ts`, `src/routes/index.ts`, `src/middleware/auth.ts`',
|
|
].join('\n'));
|
|
|
|
const result = runGsdTools(`template select .planning/phases/01-setup/01-01-PLAN.md`, tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.type, 'standard');
|
|
});
|
|
|
|
test('selects complex template for plan with decisions and many files', () => {
|
|
const planPath = path.join(tmpDir, '.planning', 'phases', '01-setup', '01-01-PLAN.md');
|
|
const lines = ['# Plan', ''];
|
|
for (let i = 1; i <= 6; i++) {
|
|
lines.push(`### Task ${i}`, `Do task ${i}.`, '');
|
|
}
|
|
lines.push('Made a decision about architecture.', 'Another decision here.');
|
|
for (let i = 1; i <= 8; i++) {
|
|
lines.push(`File: \`src/module${i}/index.ts\``);
|
|
}
|
|
fs.writeFileSync(planPath, lines.join('\n'));
|
|
|
|
const result = runGsdTools(`template select .planning/phases/01-setup/01-01-PLAN.md`, tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.type, 'complex');
|
|
});
|
|
|
|
test('returns standard as fallback for nonexistent file', () => {
|
|
const result = runGsdTools(`template select .planning/phases/01-setup/nonexistent.md`, tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.type, 'standard');
|
|
assert.ok(out.error, 'should include error message');
|
|
});
|
|
});
|
|
|
|
// ─── template fill ────────────────────────────────────────────────────────────
|
|
|
|
describe('template fill command', () => {
|
|
let tmpDir;
|
|
|
|
beforeEach(() => {
|
|
tmpDir = createTempProject();
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-setup');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
'## Roadmap\n\n### Phase 1: Setup\n**Goal:** Initial setup\n'
|
|
);
|
|
});
|
|
|
|
afterEach(() => {
|
|
cleanup(tmpDir);
|
|
});
|
|
|
|
test('fills summary template', () => {
|
|
const result = runGsdTools('template fill summary --phase 1', tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.created, true);
|
|
assert.ok(out.path.includes('01-01-SUMMARY.md'));
|
|
|
|
const content = fs.readFileSync(path.join(tmpDir, out.path), 'utf-8');
|
|
assert.ok(content.includes('---'), 'should have frontmatter');
|
|
assert.ok(content.includes('Phase 1'), 'should reference phase');
|
|
assert.ok(content.includes('Accomplishments'), 'should have accomplishments section');
|
|
});
|
|
|
|
test('fills plan template', () => {
|
|
const result = runGsdTools('template fill plan --phase 1', tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.created, true);
|
|
assert.ok(out.path.includes('01-01-PLAN.md'));
|
|
|
|
const content = fs.readFileSync(path.join(tmpDir, out.path), 'utf-8');
|
|
assert.ok(content.includes('---'), 'should have frontmatter');
|
|
assert.ok(content.includes('Objective'), 'should have objective section');
|
|
assert.ok(content.includes('<task type="code">'), 'should have task XML');
|
|
});
|
|
|
|
test('fills verification template', () => {
|
|
const result = runGsdTools('template fill verification --phase 1', tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.strictEqual(out.created, true);
|
|
assert.ok(out.path.includes('01-VERIFICATION.md'));
|
|
|
|
const content = fs.readFileSync(path.join(tmpDir, out.path), 'utf-8');
|
|
assert.ok(content.includes('Observable Truths'), 'should have truths section');
|
|
assert.ok(content.includes('Required Artifacts'), 'should have artifacts section');
|
|
});
|
|
|
|
test('rejects existing file', () => {
|
|
// Create the file first
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-setup');
|
|
fs.writeFileSync(path.join(phaseDir, '01-01-SUMMARY.md'), '# Existing');
|
|
|
|
const result = runGsdTools('template fill summary --phase 1', tmpDir);
|
|
assert.ok(result.success); // outputs JSON, doesn't crash
|
|
const out = JSON.parse(result.output);
|
|
assert.ok(out.error, 'should report error for existing file');
|
|
assert.ok(out.error.includes('already exists'));
|
|
});
|
|
|
|
test('errors on unknown template type', () => {
|
|
const result = runGsdTools('template fill bogus --phase 1', tmpDir);
|
|
assert.ok(!result.success, 'should fail for unknown type');
|
|
assert.ok(result.error.includes('Unknown template type'));
|
|
});
|
|
|
|
test('errors when phase not found', () => {
|
|
const result = runGsdTools('template fill summary --phase 99', tmpDir);
|
|
assert.ok(result.success);
|
|
const out = JSON.parse(result.output);
|
|
assert.ok(out.error, 'should report phase not found');
|
|
});
|
|
|
|
test('respects --plan option for plan number', () => {
|
|
const result = runGsdTools('template fill plan --phase 1 --plan 03', tmpDir);
|
|
assert.ok(result.success, `Failed: ${result.error}`);
|
|
const out = JSON.parse(result.output);
|
|
assert.ok(out.path.includes('01-03-PLAN.md'), `Expected plan 03 in path, got ${out.path}`);
|
|
});
|
|
});
|