* 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
This commit is contained in:
81
scripts/lint-no-source-grep-extras.cjs
Normal file
81
scripts/lint-no-source-grep-extras.cjs
Normal file
@@ -0,0 +1,81 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* Extended detector for the no-source-grep rule (#2982).
|
||||
*
|
||||
* The base lint (scripts/lint-no-source-grep.cjs) only catches the
|
||||
* direct-chain form: readFileSync(...).includes(...). The much more common
|
||||
* var-binding form escapes it:
|
||||
*
|
||||
* const src = fs.readFileSync(p, 'utf8');
|
||||
* // ... 50 lines later ...
|
||||
* assert.ok(src.includes('foo')); // ← still source-grep, lint missed it
|
||||
*
|
||||
* This module exposes pure detectors that scan source text and return
|
||||
* structured violation records. The CLI wrapper (in the base lint) calls
|
||||
* these for each test file.
|
||||
*
|
||||
* Tests assert on the typed VIOLATION enum codes, not on prose messages.
|
||||
*/
|
||||
|
||||
const VIOLATION = Object.freeze({
|
||||
VAR_FROM_READFILE_USED_IN_TEXT_MATCH: 'var_from_readfile_used_in_text_match',
|
||||
WRAPPED_ASSERT_OK_MATCH: 'wrapped_assert_ok_match',
|
||||
});
|
||||
|
||||
const TEXT_MATCH_METHODS = ['includes', 'startsWith', 'endsWith', 'match', 'search'];
|
||||
|
||||
/**
|
||||
* Single-pass scanner. Tracks variables bound from a readFileSync call,
|
||||
* then flags any subsequent <var>.<method>( use where method is one of
|
||||
* TEXT_MATCH_METHODS.
|
||||
*/
|
||||
function detectVarBindingViolations(src) {
|
||||
// Pass 1: collect variables bound from readFileSync.
|
||||
// Matches: const|let|var <name> = [fs.]readFileSync(
|
||||
const bindRe = /(?:const|let|var)\s+([A-Za-z_$][\w$]*)\s*=\s*(?:[A-Za-z_$][\w$.]*\.)?readFileSync\s*\(/g;
|
||||
const boundVars = new Set();
|
||||
let m;
|
||||
while ((m = bindRe.exec(src)) !== null) {
|
||||
boundVars.add(m[1]);
|
||||
}
|
||||
if (boundVars.size === 0) return [];
|
||||
|
||||
// Pass 2: find <var>.<method>( on any bound var.
|
||||
const findings = [];
|
||||
// Build a regex alternation from the bound var names.
|
||||
const alt = [...boundVars].map((v) => v.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|');
|
||||
const useRe = new RegExp(
|
||||
`\\b(${alt})\\s*\\.\\s*(${TEXT_MATCH_METHODS.join('|')})\\s*\\(`,
|
||||
'g',
|
||||
);
|
||||
while ((m = useRe.exec(src)) !== null) {
|
||||
findings.push({
|
||||
kind: VIOLATION.VAR_FROM_READFILE_USED_IN_TEXT_MATCH,
|
||||
variable: m[1],
|
||||
method: m[2],
|
||||
});
|
||||
}
|
||||
return findings;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detects assert.ok(<expr>.match(/.../)) and assert.ok(<expr>.match(<expr>))
|
||||
* which is the same anti-pattern as assert.match but escapes the simpler
|
||||
* regex used by the base lint.
|
||||
*/
|
||||
function detectWrappedAssertOkMatch(src) {
|
||||
const re = /assert\.ok\s*\(\s*[A-Za-z_$][\w$.]*\.match\s*\(/g;
|
||||
const findings = [];
|
||||
let m;
|
||||
while ((m = re.exec(src)) !== null) {
|
||||
findings.push({ kind: VIOLATION.WRAPPED_ASSERT_OK_MATCH });
|
||||
}
|
||||
return findings;
|
||||
}
|
||||
|
||||
function detectAll(src) {
|
||||
return [...detectVarBindingViolations(src), ...detectWrappedAssertOkMatch(src)];
|
||||
}
|
||||
|
||||
module.exports = { detectVarBindingViolations, detectWrappedAssertOkMatch, detectAll, VIOLATION };
|
||||
@@ -110,6 +110,28 @@ function check(filepath) {
|
||||
}
|
||||
}
|
||||
|
||||
// Patterns F..G (#2982): var-binding readFileSync().<text-method>() and
|
||||
// assert.ok(<expr>.match(...)). These escape the simpler patterns above
|
||||
// because the bind and the use are on different lines or wrapped.
|
||||
const extras = require('./lint-no-source-grep-extras.cjs');
|
||||
const varBindFindings = extras.detectVarBindingViolations(content);
|
||||
if (varBindFindings.length > 0) {
|
||||
const samples = varBindFindings.slice(0, 3)
|
||||
.map((f) => `${f.variable}.${f.method}()`)
|
||||
.join(', ');
|
||||
violations.push({
|
||||
reason: `readFileSync-bound variable used in text-match method: ${samples}${varBindFindings.length > 3 ? `, …+${varBindFindings.length - 3} more` : ''}`,
|
||||
fix: 'Expose typed IR; assert on structured fields. Or // allow-test-rule: <reason>',
|
||||
});
|
||||
}
|
||||
const wrappedFindings = extras.detectWrappedAssertOkMatch(content);
|
||||
if (wrappedFindings.length > 0) {
|
||||
violations.push({
|
||||
reason: `assert.ok(<expr>.match(...)) — escapes assert.match rule (${wrappedFindings.length} occurrence${wrappedFindings.length > 1 ? 's' : ''})`,
|
||||
fix: 'Use assert.equal on a typed field, not regex match on text. Or // allow-test-rule: <reason>',
|
||||
});
|
||||
}
|
||||
|
||||
if (violations.length === 0) return null;
|
||||
return { file: rel, violations };
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user