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
65 lines
2.5 KiB
JavaScript
65 lines
2.5 KiB
JavaScript
'use strict';
|
|
|
|
// 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.
|
|
|
|
/**
|
|
* Locks docs/INVENTORY.md's "(N shipped)" headline counts against the
|
|
* filesystem for each of the six families. INVENTORY.md is the
|
|
* authoritative roster — if a surface ships, its row must exist here
|
|
* and the headline count must match ls.
|
|
*
|
|
* Both sides are computed at test runtime — no hardcoded numbers.
|
|
*
|
|
* Related: docs readiness refresh, lane-12 recommendation.
|
|
*/
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
|
|
const ROOT = path.resolve(__dirname, '..');
|
|
const INVENTORY_MD = path.join(ROOT, 'docs', 'INVENTORY.md');
|
|
const INVENTORY = fs.readFileSync(INVENTORY_MD, 'utf8');
|
|
|
|
const FAMILIES = [
|
|
{ label: 'Agents', dir: 'agents', filter: (f) => /^gsd-.*\.md$/.test(f) },
|
|
{ label: 'Commands', dir: 'commands/gsd', filter: (f) => f.endsWith('.md') },
|
|
{ label: 'Workflows', dir: 'get-shit-done/workflows', filter: (f) => f.endsWith('.md') },
|
|
{ label: 'References', dir: 'get-shit-done/references', filter: (f) => f.endsWith('.md') },
|
|
{ label: 'CLI Modules', dir: 'get-shit-done/bin/lib', filter: (f) => f.endsWith('.cjs') },
|
|
{ label: 'Hooks', dir: 'hooks', filter: (f) => /\.(js|sh)$/.test(f) },
|
|
];
|
|
|
|
function headlineCount(label) {
|
|
const re = new RegExp(`^##\\s+${label}\\s+\\((\\d+)\\s+shipped\\)`, 'm');
|
|
const m = INVENTORY.match(re);
|
|
assert.ok(m, `docs/INVENTORY.md is missing the "## ${label} (N shipped)" header`);
|
|
return parseInt(m[1], 10);
|
|
}
|
|
|
|
function fsCount(relDir, filter) {
|
|
return fs
|
|
.readdirSync(path.join(ROOT, relDir))
|
|
.filter((name) => fs.statSync(path.join(ROOT, relDir, name)).isFile())
|
|
.filter(filter)
|
|
.length;
|
|
}
|
|
|
|
describe('docs/INVENTORY.md headline counts match the filesystem', () => {
|
|
for (const { label, dir, filter } of FAMILIES) {
|
|
test(`"${label} (N shipped)" matches ${dir}/`, () => {
|
|
const documented = headlineCount(label);
|
|
const actual = fsCount(dir, filter);
|
|
assert.strictEqual(
|
|
documented,
|
|
actual,
|
|
`docs/INVENTORY.md "${label} (${documented} shipped)" disagrees with ${dir}/ file count (${actual}) — update the headline and the row list`,
|
|
);
|
|
});
|
|
}
|
|
});
|