918f987a19
* 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
83 lines
3.2 KiB
JavaScript
83 lines
3.2 KiB
JavaScript
// allow-test-rule: source-text-is-the-product
|
|
// Reads .md/.json/.yml product files whose deployed text IS what the
|
|
// runtime loads — testing text content tests the deployed contract.
|
|
|
|
/**
|
|
* GSD Agent Required Reading Consistency Tests
|
|
*
|
|
* Validates that all agent .md files use the standardized <required_reading>
|
|
* pattern and that no legacy <files_to_read> blocks remain.
|
|
*
|
|
* See: https://github.com/gsd-build/get-shit-done/issues/2168
|
|
*/
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const AGENTS_DIR = path.join(__dirname, '..', 'agents');
|
|
|
|
const ALL_AGENTS = fs.readdirSync(AGENTS_DIR)
|
|
.filter(f => f.startsWith('gsd-') && f.endsWith('.md'))
|
|
.map(f => f.replace('.md', ''));
|
|
|
|
// ─── No Legacy files_to_read Blocks ────────────────────────────────────────
|
|
|
|
describe('READING: no legacy <files_to_read> blocks remain', () => {
|
|
for (const agent of ALL_AGENTS) {
|
|
test(`${agent} does not contain <files_to_read>`, () => {
|
|
const content = fs.readFileSync(path.join(AGENTS_DIR, agent + '.md'), 'utf-8');
|
|
assert.ok(
|
|
!content.includes('<files_to_read>'),
|
|
`${agent} still has <files_to_read> opening tag — migrate to <required_reading>`
|
|
);
|
|
assert.ok(
|
|
!content.includes('</files_to_read>'),
|
|
`${agent} still has </files_to_read> closing tag — migrate to </required_reading>`
|
|
);
|
|
});
|
|
}
|
|
|
|
test('no backtick references to files_to_read in any agent', () => {
|
|
for (const agent of ALL_AGENTS) {
|
|
const content = fs.readFileSync(path.join(AGENTS_DIR, agent + '.md'), 'utf-8');
|
|
assert.ok(
|
|
!content.includes('`<files_to_read>`'),
|
|
`${agent} still references \`<files_to_read>\` in prose — update to \`<required_reading>\``
|
|
);
|
|
}
|
|
});
|
|
});
|
|
|
|
// ─── Standardized required_reading Pattern ─────────────────────────────────
|
|
|
|
describe('READING: agents with reading blocks use <required_reading>', () => {
|
|
// Agents that have any kind of reading instruction should use required_reading
|
|
const AGENTS_WITH_READING = ALL_AGENTS.filter(name => {
|
|
const content = fs.readFileSync(path.join(AGENTS_DIR, name + '.md'), 'utf-8');
|
|
return content.includes('required_reading') || content.includes('files_to_read');
|
|
});
|
|
|
|
test('at least 20 agents have reading instructions', () => {
|
|
assert.ok(
|
|
AGENTS_WITH_READING.length >= 20,
|
|
`Expected at least 20 agents with reading instructions, found ${AGENTS_WITH_READING.length}`
|
|
);
|
|
});
|
|
|
|
for (const agent of AGENTS_WITH_READING) {
|
|
test(`${agent} uses required_reading (not files_to_read)`, () => {
|
|
const content = fs.readFileSync(path.join(AGENTS_DIR, agent + '.md'), 'utf-8');
|
|
assert.ok(
|
|
content.includes('required_reading'),
|
|
`${agent} has reading instructions but does not use required_reading`
|
|
);
|
|
assert.ok(
|
|
!content.includes('files_to_read'),
|
|
`${agent} still uses files_to_read — must be migrated to required_reading`
|
|
);
|
|
});
|
|
}
|
|
});
|