* 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
94 lines
4.1 KiB
JavaScript
94 lines
4.1 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.
|
|
|
|
/**
|
|
* GSD Tools Tests - discuss-phase incremental checkpoint saves
|
|
*
|
|
* Validates that the discuss-phase workflow includes incremental
|
|
* checkpoint logic to prevent answer loss on session interruption.
|
|
*
|
|
* Closes: #1485
|
|
*/
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
describe('discuss-phase incremental checkpoint saves (#1485)', () => {
|
|
const workflowPath = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase.md');
|
|
// After #2551 progressive-disclosure refactor, checkpoint logic lives in the
|
|
// default mode file and the JSON schema lives in the templates directory.
|
|
const defaultModePath = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase', 'modes', 'default.md');
|
|
const checkpointTplPath = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase', 'templates', 'checkpoint.json');
|
|
|
|
function readAll() {
|
|
// Fail loudly if any required source is missing — silent filtering would
|
|
// let a regression that deletes the extracted default-mode or checkpoint
|
|
// template pass the suite.
|
|
for (const p of [workflowPath, defaultModePath, checkpointTplPath]) {
|
|
assert.ok(fs.existsSync(p), `Required discuss-phase checkpoint source missing: ${p}`);
|
|
}
|
|
return [workflowPath, defaultModePath, checkpointTplPath]
|
|
.map(p => fs.readFileSync(p, 'utf8'))
|
|
.join('\n');
|
|
}
|
|
|
|
test('workflow writes checkpoint file after each area completes', () => {
|
|
const content = readAll();
|
|
assert.ok(
|
|
content.includes('DISCUSS-CHECKPOINT.json'),
|
|
'workflow should reference checkpoint JSON file'
|
|
);
|
|
assert.ok(
|
|
content.includes('Incremental checkpoint') || content.includes('incremental checkpoint'),
|
|
'workflow should describe incremental checkpoint saves'
|
|
);
|
|
});
|
|
|
|
test('checkpoint includes decisions, areas completed, and areas remaining', () => {
|
|
const content = readAll();
|
|
assert.ok(content.includes('areas_completed'), 'checkpoint should track completed areas');
|
|
assert.ok(content.includes('areas_remaining'), 'checkpoint should track remaining areas');
|
|
assert.ok(content.includes('"decisions"'), 'checkpoint should include decisions object');
|
|
});
|
|
|
|
test('check_existing step detects checkpoint for session resume', () => {
|
|
const content = readAll();
|
|
// The check_existing step should look for checkpoint files
|
|
assert.ok(
|
|
content.includes('DISCUSS-CHECKPOINT.json') && content.includes('Resume'),
|
|
'check_existing should detect checkpoint and offer resume'
|
|
);
|
|
});
|
|
|
|
test('checkpoint is cleaned up after successful CONTEXT.md write', () => {
|
|
const content = fs.readFileSync(workflowPath, 'utf8');
|
|
assert.ok(
|
|
content.includes('rm -f') && content.includes('DISCUSS-CHECKPOINT'),
|
|
'checkpoint file should be deleted after successful write_context'
|
|
);
|
|
});
|
|
|
|
test('success criteria include checkpoint requirements', () => {
|
|
const content = fs.readFileSync(workflowPath, 'utf8');
|
|
const criteriaMatch = content.match(/<success_criteria>([\s\S]*?)<\/success_criteria>/);
|
|
const criteria = criteriaMatch ? criteriaMatch[1] : '';
|
|
assert.ok(criteria.includes('checkpoint') || criteria.includes('Checkpoint'),
|
|
'success criteria should mention checkpoints');
|
|
assert.ok(criteria.includes('resume') || criteria.includes('Resume'),
|
|
'success criteria should mention session resume capability');
|
|
});
|
|
|
|
test('auto mode also writes checkpoints', () => {
|
|
const content = fs.readFileSync(workflowPath, 'utf8');
|
|
// The checkpoint section should mention auto mode
|
|
assert.ok(
|
|
content.includes('auto-resolves') || content.includes('--auto'),
|
|
'checkpoint logic should apply to both interactive and auto modes'
|
|
);
|
|
});
|
|
});
|