* 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
107 lines
4.2 KiB
JavaScript
107 lines
4.2 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.
|
|
|
|
/**
|
|
* Regression guard for #1767: gsd-workflow-guard.js must be registered in settings.json
|
|
*
|
|
* The hook file is built, copied, and installed — but was never registered as a
|
|
* PreToolUse hook entry in install.js. This test ensures the registration block
|
|
* exists with the correct structure.
|
|
*
|
|
* Also tests the broader anti-pattern: every hook in gsdHooks that is a JS
|
|
* PreToolUse/PostToolUse hook should have a corresponding registration block.
|
|
*/
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
const INSTALL_JS = path.join(__dirname, '..', 'bin', 'install.js');
|
|
|
|
describe('workflow-guard hook registration (#1767)', () => {
|
|
test('install.js constructs a command path variable for gsd-workflow-guard.js', () => {
|
|
const content = fs.readFileSync(INSTALL_JS, 'utf-8');
|
|
const lines = content.split('\n');
|
|
// Every registered JS hook has a command variable constructed via
|
|
// buildHookCommand() or string concatenation. Filter out references
|
|
// that are only in the cleanup/uninstall arrays.
|
|
const commandConstructionLines = lines.filter(line =>
|
|
line.includes('gsd-workflow-guard.js') &&
|
|
(line.includes('buildHookCommand') || line.includes("'node '"))
|
|
);
|
|
assert.ok(
|
|
commandConstructionLines.length > 0,
|
|
[
|
|
'install.js must construct a command path for gsd-workflow-guard.js',
|
|
'(e.g. buildHookCommand or node + dirName pattern).',
|
|
'Currently only referenced in gsdHooks cleanup array.',
|
|
].join(' ')
|
|
);
|
|
});
|
|
|
|
test('install.js has a hasWorkflowGuardHook dedup check', () => {
|
|
const content = fs.readFileSync(INSTALL_JS, 'utf-8');
|
|
// Every registered hook has a dedup check: hasXxxHook = settings.hooks[...].some(...)
|
|
const hasDedup = content.includes('hasWorkflowGuardHook') ||
|
|
content.includes('hasWorkflowGuard');
|
|
assert.ok(
|
|
hasDedup,
|
|
'install.js must have a dedup check variable for workflow-guard (like hasPromptGuardHook)'
|
|
);
|
|
});
|
|
|
|
test('install.js pushes workflow-guard entry with correct matcher', () => {
|
|
const content = fs.readFileSync(INSTALL_JS, 'utf-8');
|
|
// Extract the section between "workflow-guard" command construction
|
|
// and the next console.log confirmation. The push block should have:
|
|
// matcher: 'Write|Edit' and command referencing workflow-guard
|
|
const workflowGuardSection = content.match(
|
|
/workflowGuardCommand[\s\S]*?console\.log\([^)]*workflow.guard/i
|
|
);
|
|
assert.ok(
|
|
workflowGuardSection,
|
|
'install.js must have a push block for workflow-guard with a console.log confirmation'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('hook registration completeness anti-pattern guard', () => {
|
|
test('every JS hook in gsdHooks has a command construction in install.js', () => {
|
|
const content = fs.readFileSync(INSTALL_JS, 'utf-8');
|
|
// Extract gsdHooks array entries
|
|
const hooksMatch = content.match(/gsdHooks\s*=\s*\[([^\]]+)\]/);
|
|
assert.ok(hooksMatch, 'gsdHooks array must exist in install.js');
|
|
|
|
const hookNames = hooksMatch[1]
|
|
.match(/'([^']+)'/g)
|
|
.map(h => h.replace(/'/g, ''));
|
|
|
|
const jsHooks = hookNames.filter(h => h.endsWith('.js'));
|
|
|
|
const missing = [];
|
|
for (const hook of jsHooks) {
|
|
// Each JS hook should have a buildHookCommand or 'node ' command construction
|
|
// that references the hook filename (not just the gsdHooks array or uninstall filter)
|
|
const hookBase = hook.replace('.js', '');
|
|
const lines = content.split('\n').filter(line =>
|
|
line.includes(hook) &&
|
|
(line.includes('buildHookCommand') || line.includes("'node '"))
|
|
);
|
|
if (lines.length === 0) {
|
|
missing.push(hook);
|
|
}
|
|
}
|
|
|
|
assert.strictEqual(
|
|
missing.length, 0,
|
|
[
|
|
'Every JS hook in gsdHooks must have a command construction in install.js.',
|
|
'Missing registration for:',
|
|
...missing.map(h => ` - ${h}`),
|
|
].join('\n')
|
|
);
|
|
});
|
|
});
|