Install eslint@9 + typescript-eslint@8 + globals@16 + eslint-plugin-n@17 + eslint-plugin-no-only-tests@3 + typescript as devDependencies. eslint.config.mjs (flat config): - Global ignores: node_modules, dist, .worktrees, .claude, coverage, the 12 generated get-shit-done/bin/lib/*.cjs files - Block for get-shit-done/bin/**/*.cjs + scripts/**/*.cjs: js.recommended + eslint-plugin-n + local plugin; generic quality rules (no-var, prefer-const, no-unused-vars, no-empty, n/no-process-exit) - Block for tests/**/*.test.cjs: no-only-tests (error), local timing rules, no-restricted-syntax timing bans eslint-rules/ local plugin (three AST rules, all at warn pending cleanup): - no-source-grep: flag readFileSync on source .cjs/.js/.ts + text methods - no-magic-sleep-in-tests: flag Atomics.wait and await-new-Promise(setTimeout) - no-elapsed-assertion: flag assert*() on timing props (elapsed/duration/took/ms) tsconfig.lint.json: allowJs + checkJs + noEmit for future type-aware passes. tests/eslint-rules.test.cjs: 15 RuleTester unit tests (all pass, 0 fail). package.json: add lint/lint:fix scripts; remove lint:tests (subsumed by ESLint local/no-source-grep). Rules that produced pre-existing errors downgraded to warn: no-useless-escape, no-unsafe-finally, no-regex-spaces, no-control-regex, no-irregular-whitespace. ESLint exits 0 (warnings ok). .github/workflows/test.yml lint-tests job: add npm ci + ESLint step; remove "Lint — no source-grep tests" step (now covered by ESLint); bump timeout 3→5 min. .gitignore: add node_modules/.cache/eslint/ entry. eslint --fix auto-cleaned: no-regex-spaces in tests, prefer-const in state.cjs, redundant eslint-disable-next-line comments. Co-authored-by: CI Rebase Check <ci@gsd-redux> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
103
eslint-rules/no-elapsed-assertion.cjs
Normal file
103
eslint-rules/no-elapsed-assertion.cjs
Normal file
@@ -0,0 +1,103 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* no-elapsed-assertion
|
||||
*
|
||||
* Flag assert*() calls whose argument reads a property named
|
||||
* /^(elapsed|duration|took|ms)$/ or compares such an identifier.
|
||||
* Timing assertions are flaky and should not be in the test suite.
|
||||
*/
|
||||
|
||||
/** @type {import('eslint').Rule.RuleModule} */
|
||||
const rule = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
docs: {
|
||||
description:
|
||||
'Disallow timing assertions (elapsed, duration, took, ms) in assert calls',
|
||||
category: 'Best Practices',
|
||||
},
|
||||
schema: [],
|
||||
messages: {
|
||||
noElapsedAssertion:
|
||||
'Timing assertion detected: assert*() on a timing property (elapsed/duration/took/ms). Timing assertions are flaky — assert on observable behavior instead.',
|
||||
},
|
||||
},
|
||||
create(context) {
|
||||
const TIMING_PROPS = /^(elapsed|duration|took|ms)$/;
|
||||
|
||||
function containsTimingRef(node) {
|
||||
if (!node) return false;
|
||||
|
||||
// foo.elapsed, foo.duration, foo.took, foo.ms
|
||||
if (
|
||||
node.type === 'MemberExpression' &&
|
||||
node.property.type === 'Identifier' &&
|
||||
TIMING_PROPS.test(node.property.name)
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Identifier directly: elapsed, duration, took, ms
|
||||
if (node.type === 'Identifier' && TIMING_PROPS.test(node.name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Binary expression: elapsed > 100, duration <= 500, etc.
|
||||
if (node.type === 'BinaryExpression') {
|
||||
return containsTimingRef(node.left) || containsTimingRef(node.right);
|
||||
}
|
||||
|
||||
// Logical expression: elapsed && elapsed > 0
|
||||
if (node.type === 'LogicalExpression') {
|
||||
return containsTimingRef(node.left) || containsTimingRef(node.right);
|
||||
}
|
||||
|
||||
// UnaryExpression: !elapsed
|
||||
if (node.type === 'UnaryExpression') {
|
||||
return containsTimingRef(node.argument);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
function isAssertCall(node) {
|
||||
if (node.callee.type === 'Identifier') {
|
||||
return /^assert/.test(node.callee.name);
|
||||
}
|
||||
if (
|
||||
node.callee.type === 'MemberExpression' &&
|
||||
node.callee.object.type === 'Identifier' &&
|
||||
node.callee.object.name === 'assert'
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
// assert.strict.* or assert/strict
|
||||
if (
|
||||
node.callee.type === 'MemberExpression' &&
|
||||
node.callee.object.type === 'MemberExpression' &&
|
||||
node.callee.object.object.type === 'Identifier' &&
|
||||
node.callee.object.object.name === 'assert'
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
return {
|
||||
CallExpression(node) {
|
||||
if (!isAssertCall(node)) return;
|
||||
|
||||
// Check all arguments for timing refs
|
||||
for (const arg of node.arguments) {
|
||||
if (containsTimingRef(arg)) {
|
||||
context.report({ node, messageId: 'noElapsedAssertion' });
|
||||
return;
|
||||
}
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = rule;
|
||||
80
eslint-rules/no-magic-sleep-in-tests.cjs
Normal file
80
eslint-rules/no-magic-sleep-in-tests.cjs
Normal file
@@ -0,0 +1,80 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* no-magic-sleep-in-tests
|
||||
*
|
||||
* In *.test.cjs files, flag:
|
||||
* - Atomics.wait used as a sleep
|
||||
* - raw setTimeout used for synchronization (i.e., awaited or used without a callback driven by logic)
|
||||
*/
|
||||
|
||||
/** @type {import('eslint').Rule.RuleModule} */
|
||||
const rule = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
docs: {
|
||||
description:
|
||||
'Disallow Atomics.wait sleeps and raw setTimeout synchronization in test files',
|
||||
category: 'Best Practices',
|
||||
},
|
||||
schema: [],
|
||||
messages: {
|
||||
atomicsWaitSleep:
|
||||
'Atomics.wait() used as a sleep in tests. Use a proper async wait pattern instead.',
|
||||
setTimeoutSync:
|
||||
'Raw setTimeout used for synchronization in tests. Use proper async patterns (promises, events, polling) instead.',
|
||||
},
|
||||
},
|
||||
create(context) {
|
||||
const filename = context.getFilename();
|
||||
|
||||
// Only applies in test files
|
||||
if (!filename.endsWith('.test.cjs')) return {};
|
||||
|
||||
return {
|
||||
CallExpression(node) {
|
||||
// Atomics.wait(...)
|
||||
if (
|
||||
node.callee.type === 'MemberExpression' &&
|
||||
node.callee.object.type === 'Identifier' &&
|
||||
node.callee.object.name === 'Atomics' &&
|
||||
node.callee.property.name === 'wait'
|
||||
) {
|
||||
context.report({ node, messageId: 'atomicsWaitSleep' });
|
||||
}
|
||||
|
||||
// setTimeout(...) used for synchronization:
|
||||
// - await new Promise(resolve => setTimeout(resolve, N))
|
||||
// - setTimeout(() => resolve(...), N) pattern
|
||||
// - setTimeout(cb, N) where N is a numeric literal (magic delay)
|
||||
if (
|
||||
node.callee.type === 'Identifier' &&
|
||||
node.callee.name === 'setTimeout'
|
||||
) {
|
||||
const args = node.arguments;
|
||||
// setTimeout(something, numericLiteral) — magic delay
|
||||
if (
|
||||
args.length >= 2 &&
|
||||
args[1].type === 'Literal' &&
|
||||
typeof args[1].value === 'number'
|
||||
) {
|
||||
// Check if it's in an await expression or a Promise constructor
|
||||
const parent = node.parent;
|
||||
const grandParent = parent && parent.parent;
|
||||
const isInPromise =
|
||||
(grandParent &&
|
||||
grandParent.type === 'NewExpression' &&
|
||||
grandParent.callee.type === 'Identifier' &&
|
||||
grandParent.callee.name === 'Promise') ||
|
||||
(parent && parent.type === 'AwaitExpression');
|
||||
if (isInPromise) {
|
||||
context.report({ node, messageId: 'setTimeoutSync' });
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = rule;
|
||||
116
eslint-rules/no-source-grep.cjs
Normal file
116
eslint-rules/no-source-grep.cjs
Normal file
@@ -0,0 +1,116 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* no-source-grep
|
||||
*
|
||||
* Flags variables bound to readFileSync() of a .cjs/.js/.ts source path that
|
||||
* later have .includes/.match/.startsWith/.indexOf called on them.
|
||||
*
|
||||
* Honor file-level escape comment: // allow-test-rule: <reason>
|
||||
*/
|
||||
|
||||
/** @type {import('eslint').Rule.RuleModule} */
|
||||
const rule = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
docs: {
|
||||
description:
|
||||
'Disallow reading source .cjs/.js/.ts files with readFileSync and then doing text search on the result',
|
||||
category: 'Best Practices',
|
||||
},
|
||||
schema: [],
|
||||
messages: {
|
||||
noSourceGrep:
|
||||
'Source-grep test: do not read source .cjs/.js/.ts files with readFileSync and call .includes/.match/.startsWith/.indexOf on the result. Use require() to run the module instead. Add // allow-test-rule: <reason> at the top of the file to suppress.',
|
||||
},
|
||||
},
|
||||
create(context) {
|
||||
const sourceCode = context.getSourceCode
|
||||
? context.getSourceCode()
|
||||
: context.sourceCode;
|
||||
|
||||
// Check for file-level escape comment
|
||||
const comments = sourceCode.getAllComments();
|
||||
const hasAllowAnnotation = comments.some(
|
||||
(c) => /allow-test-rule:\s*\S/.test(c.value)
|
||||
);
|
||||
if (hasAllowAnnotation) return {};
|
||||
|
||||
// Track variable names bound to readFileSync of a source path
|
||||
const sourceGrepVars = new Set();
|
||||
|
||||
// Detect if a node represents a readFileSync call on a source file (.cjs/.js/.ts)
|
||||
// that lives in a source directory (bin, lib, get-shit-done, src).
|
||||
function isSourceReadFileSync(node) {
|
||||
if (node.type !== 'CallExpression') return false;
|
||||
|
||||
// Match: readFileSync(...) or fs.readFileSync(...) or require('fs').readFileSync(...)
|
||||
const callee = node.callee;
|
||||
const isFsRead =
|
||||
(callee.type === 'Identifier' && callee.name === 'readFileSync') ||
|
||||
(callee.type === 'MemberExpression' &&
|
||||
callee.property.type === 'Identifier' &&
|
||||
callee.property.name === 'readFileSync');
|
||||
|
||||
if (!isFsRead) return false;
|
||||
|
||||
const args = node.arguments;
|
||||
if (!args || args.length === 0) return false;
|
||||
|
||||
const firstArg = args[0];
|
||||
const fullSrc = sourceCode.getText(firstArg);
|
||||
|
||||
return looksLikeSourcePath(fullSrc);
|
||||
}
|
||||
|
||||
// Given the source text of a path expression, determine if it references
|
||||
// a .cjs/.js/.ts source file in a source directory.
|
||||
function looksLikeSourcePath(src) {
|
||||
// Must end with a .cjs, .js, or .ts extension (in a string)
|
||||
const hasCjsExt = /['"`.][^'"`.]*\.(?:cjs|js|ts)['"`)]/i.test(src);
|
||||
if (!hasCjsExt) return false;
|
||||
|
||||
// Must reference a source directory indicator somewhere in the expression
|
||||
const hasSourceDir = /['"](?:bin|lib|get-shit-done|src)['"]/i.test(src);
|
||||
return hasSourceDir;
|
||||
}
|
||||
|
||||
const TEXT_METHODS = new Set(['includes', 'match', 'startsWith', 'endsWith', 'indexOf', 'search']);
|
||||
|
||||
return {
|
||||
VariableDeclarator(node) {
|
||||
// const varName = readFileSync(...) OR const varName = fs.readFileSync(...)
|
||||
if (node.init && isSourceReadFileSync(node.init)) {
|
||||
if (node.id.type === 'Identifier') {
|
||||
sourceGrepVars.add(node.id.name);
|
||||
}
|
||||
}
|
||||
},
|
||||
AssignmentExpression(node) {
|
||||
if (node.right && isSourceReadFileSync(node.right)) {
|
||||
if (node.left.type === 'Identifier') {
|
||||
sourceGrepVars.add(node.left.name);
|
||||
}
|
||||
}
|
||||
},
|
||||
CallExpression(node) {
|
||||
// varName.includes(...), varName.match(...), etc.
|
||||
if (
|
||||
node.callee.type === 'MemberExpression' &&
|
||||
TEXT_METHODS.has(node.callee.property.name)
|
||||
) {
|
||||
const obj = node.callee.object;
|
||||
if (obj.type === 'Identifier' && sourceGrepVars.has(obj.name)) {
|
||||
context.report({ node, messageId: 'noSourceGrep' });
|
||||
}
|
||||
// Inline: readFileSync(...).includes(...)
|
||||
if (isSourceReadFileSync(obj)) {
|
||||
context.report({ node, messageId: 'noSourceGrep' });
|
||||
}
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = rule;
|
||||
Reference in New Issue
Block a user