eslint-node-test 0.0.1

package/rules/prefer-async-await.js

@@ -0,0 +1,203 @@
+import {findVariable} from '@eslint-community/eslint-utils';
+import {resolveImports, parseTestCall, getTestCallback} from './utils/node-test.js';
+
+const MESSAGE_ID = 'prefer-async-await/error';
+
+const messages = {
+	[MESSAGE_ID]: 'Prefer async/await instead of returning a Promise.',
+};
+
+/**
+Collect all `return` statements that are directly inside `block`, descending
+into control-flow nodes but not into nested functions.
+
+@param {import('estree').BlockStatement} block
+@returns {import('estree').ReturnStatement[]}
+*/
+function findReturnStatements(block) {
+	const results = [];
+
+	function walk(node) {
+		if (!node) {
+			return;
+		}
+
+		switch (node.type) {
+			case 'ReturnStatement': {
+				results.push(node);
+				break;
+			}
+
+			case 'BlockStatement': {
+				for (const statement of node.body) {
+					walk(statement);
+				}
+
+				break;
+			}
+
+			case 'IfStatement': {
+				walk(node.consequent);
+				walk(node.alternate);
+				break;
+			}
+
+			case 'SwitchStatement': {
+				for (const switchCase of node.cases) {
+					for (const statement of switchCase.consequent) {
+						walk(statement);
+					}
+				}
+
+				break;
+			}
+
+			case 'TryStatement': {
+				walk(node.block);
+				if (node.handler) {
+					walk(node.handler.body);
+				}
+
+				walk(node.finalizer);
+				break;
+			}
+
+			case 'ForStatement':
+			case 'ForInStatement':
+			case 'ForOfStatement':
+			case 'WhileStatement':
+			case 'DoWhileStatement':
+			case 'LabeledStatement':
+			case 'WithStatement': {
+				walk(node.body);
+				break;
+			}
+
+			// Do not descend into nested functions
+			default: {
+				break;
+			}
+		}
+	}
+
+	walk(block);
+
+	return results;
+}
+
+/**
+Check whether a node contains a `.then(...)` call anywhere in its `.then`/`.catch`/`.finally`
+member chain.
+
+@param {import('estree').Node | null | undefined} node
+@returns {boolean}
+*/
+function containsThen(node) {
+	if (!node) {
+		return false;
+	}
+
+	if (node.type === 'ChainExpression') {
+		return containsThen(node.expression);
+	}
+
+	if (
+		node.type !== 'CallExpression'
+		|| node.callee.type !== 'MemberExpression'
+	) {
+		return false;
+	}
+
+	const {callee} = node;
+	if (
+		callee.property.type === 'Identifier'
+		&& callee.property.name === 'then'
+	) {
+		return true;
+	}
+
+	return containsThen(callee.object);
+}
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const {sourceCode} = context;
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	context.on('CallExpression', node => {
+		const parsed = parseTestCall(node, imports);
+		if (!parsed) {
+			return;
+		}
+
+		// `describe`/`suite` callbacks run synchronously and are never awaited, so returning a
+		// Promise from them is meaningless and converting to async/await would not help.
+		if (parsed.kind === 'suite') {
+			return;
+		}
+
+		const callback = getTestCallback(node);
+		// Only flag non-async functions with a block body (arrow shorthand already returns)
+		if (!callback || callback.async || callback.body.type !== 'BlockStatement') {
+			return;
+		}
+
+		const returnStatements = findReturnStatements(callback.body);
+		if (returnStatements.length === 0) {
+			return;
+		}
+
+		// Flag if any return statement returns a .then() call chain
+		for (const returnStatement of returnStatements) {
+			if (containsThen(returnStatement.argument)) {
+				return {
+					node: callback,
+					messageId: MESSAGE_ID,
+				};
+			}
+		}
+
+		// Flag if any return statement returns a variable that was assigned from a .then() call
+		for (const returnStatement of returnStatements) {
+			if (returnStatement.argument?.type !== 'Identifier') {
+				continue;
+			}
+
+			const variable = findVariable(sourceCode.getScope(returnStatement), returnStatement.argument);
+			if (!variable) {
+				continue;
+			}
+
+			for (const definition of variable.defs) {
+				if (definition.type !== 'Variable' || !containsThen(definition.node.init)) {
+					continue;
+				}
+
+				return {
+					node: callback,
+					messageId: MESSAGE_ID,
+				};
+			}
+		}
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer async/await over returning a Promise.',
+			recommended: true,
+		},
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/prefer-context-mock.js

@@ -0,0 +1,59 @@
+import {resolveImports, isGlobalMock} from './utils/node-test.js';
+
+const MESSAGE_ID = 'prefer-context-mock';
+
+const messages = {
+	[MESSAGE_ID]: 'Prefer `t.mock.{{accessor}}` over the global `mock.{{accessor}}`, which is not automatically restored between tests.',
+};
+
+// Accessors that create state which the global `mock` does not auto-restore.
+const STATEFUL_ACCESSORS = new Set(['fn', 'method', 'getter', 'setter', 'property', 'module', 'timers']);
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	if (imports.mockLocals.size === 0 && !imports.namespace) {
+		return;
+	}
+
+	context.on('CallExpression', node => {
+		let member = node.callee;
+		while (member.type === 'MemberExpression') {
+			if (isGlobalMock(member.object, imports) && !member.computed && member.property.type === 'Identifier') {
+				const accessor = member.property.name;
+				if (STATEFUL_ACCESSORS.has(accessor)) {
+					return {
+						node,
+						messageId: MESSAGE_ID,
+						data: {accessor},
+					};
+				}
+
+				return;
+			}
+
+			member = member.object;
+		}
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer the test context `t.mock` over the global `mock`.',
+			recommended: true,
+		},
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/prefer-diagnostic.js

@@ -0,0 +1,94 @@
+import {resolveImports, createContextTracker} from './utils/node-test.js';
+
+const MESSAGE_ID_ERROR = 'prefer-diagnostic/error';
+const MESSAGE_ID_SUGGESTION = 'prefer-diagnostic/suggestion';
+
+const messages = {
+	[MESSAGE_ID_ERROR]: 'Prefer `{{context}}.diagnostic()` over `console.{{method}}()` inside a test, so the message is attached to the test as a TAP diagnostic.',
+	[MESSAGE_ID_SUGGESTION]: 'Replace with `{{context}}.diagnostic()`.',
+};
+
+const CONSOLE_METHODS = new Set(['log', 'info', 'debug']);
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	const tracker = createContextTracker(imports);
+
+	context.on('CallExpression', node => {
+		tracker.update(node);
+
+		const {callee} = node;
+		if (
+			callee.type !== 'MemberExpression'
+			|| callee.computed
+			|| callee.object.type !== 'Identifier'
+			|| callee.object.name !== 'console'
+			|| callee.property.type !== 'Identifier'
+			|| !CONSOLE_METHODS.has(callee.property.name)
+		) {
+			return;
+		}
+
+		const contextName = tracker.current();
+		if (!contextName) {
+			return;
+		}
+
+		// The context parameter is only in scope inside the test callback. Skip console calls in the
+		// title/options arguments (visited before the callback), where the context does not exist.
+		const callback = tracker.currentCallback();
+		const [callStart, callEnd] = context.sourceCode.getRange(callback);
+		const [consoleStart] = context.sourceCode.getRange(node);
+		if (consoleStart < callStart || consoleStart >= callEnd) {
+			return;
+		}
+
+		const method = callee.property.name;
+		const data = {context: contextName, method};
+		const problem = {
+			node: callee,
+			messageId: MESSAGE_ID_ERROR,
+			data,
+		};
+
+		// `diagnostic()` takes a single message, so only suggest a rewrite for a single argument.
+		if (node.arguments.length === 1) {
+			problem.suggest = [
+				{
+					messageId: MESSAGE_ID_SUGGESTION,
+					data,
+					fix: fixer => fixer.replaceText(callee, `${contextName}.diagnostic`),
+				},
+			];
+		}
+
+		return problem;
+	});
+
+	context.onExit('CallExpression', node => {
+		tracker.leave(node);
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer the test context `diagnostic()` over `console` inside tests.',
+			recommended: false,
+		},
+		hasSuggestions: true,
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/prefer-equality-assertion.js

@@ -0,0 +1,101 @@
+import {resolveImports, parseAssertionCall} from './utils/node-test.js';
+import {isParenthesized, getParenthesizedRange} from './utils/index.js';
+import unwrapTypeScriptExpression from './utils/unwrap-typescript-expression.js';
+
+const MESSAGE_ID = 'prefer-equality-assertion';
+
+const messages = {
+	[MESSAGE_ID]: 'Prefer `{{replacement}}` over `{{method}}` with a `{{operator}}` comparison for a clearer failure message.',
+};
+
+// Comparison operators and the assertion that preserves their semantics.
+const OPERATOR_TO_METHOD = new Map([
+	['===', 'strictEqual'],
+	['!==', 'notStrictEqual'],
+	['==', 'equal'],
+	['!=', 'notEqual'],
+]);
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const {sourceCode} = context;
+	const imports = resolveImports(context);
+	if (!imports.isAssertOrTestFile) {
+		return;
+	}
+
+	context.on('CallExpression', node => {
+		const parsed = parseAssertionCall(node, imports);
+		// Only the truthiness assertions (`assert(…)` / `assert.ok(…)`) benefit.
+		if (parsed?.method !== 'ok') {
+			return;
+		}
+
+		const [rawArgument] = node.arguments;
+		// Unwrap TypeScript casts (`(a === b) as boolean`) so the comparison is still recognized.
+		const argument = rawArgument && unwrapTypeScriptExpression(rawArgument);
+		if (argument?.type !== 'BinaryExpression') {
+			return;
+		}
+
+		const replacement = OPERATOR_TO_METHOD.get(argument.operator);
+		if (!replacement) {
+			return;
+		}
+
+		const {callee} = node;
+		const method = callee.type === 'MemberExpression' ? callee.property.name : 'ok';
+
+		const problem = {
+			node,
+			messageId: MESSAGE_ID,
+			data: {method, replacement, operator: argument.operator},
+		};
+
+		// Skip the autofix when it would be unsafe: extra parentheses or a comment inside
+		// the comparison would be mangled by the rewrite, and a bare named import (`ok`)
+		// cannot be rewritten to an unimported `strictEqual`.
+		const isBareNamedImport = callee.type === 'Identifier' && !imports.assertNamespace.has(callee.name);
+		if (
+			isBareNamedImport
+			|| isParenthesized(argument, context)
+			|| sourceCode.getCommentsInside(argument).length > 0
+		) {
+			return problem;
+		}
+
+		problem.fix = function * (fixer) {
+			// `assert.ok(…)` / `t.assert.ok(…)` rewrite just the method, while the bare
+			// `assert(…)` namespace function becomes `assert.strictEqual(…)`.
+			yield callee.type === 'MemberExpression'
+				? fixer.replaceText(callee.property, replacement)
+				: fixer.replaceText(callee, `${callee.name}.${replacement}`);
+
+			// Split the comparison into two arguments: `left === right` -> `left, right`.
+			// Use the parenthesized ranges so parenthesized operands stay intact.
+			const leftEnd = getParenthesizedRange(argument.left, context)[1];
+			const rightStart = getParenthesizedRange(argument.right, context)[0];
+			yield fixer.replaceTextRange([leftEnd, rightStart], ', ');
+		};
+
+		return problem;
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer an equality assertion over a truthiness assertion on a comparison.',
+			recommended: 'unopinionated',
+		},
+		fixable: 'code',
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/prefer-hooks-on-top.js

@@ -0,0 +1,73 @@
+import {resolveImports, parseTestCall, getTestCallback} from './utils/node-test.js';
+
+const MESSAGE_ID = 'prefer-hooks-on-top';
+
+const messages = {
+	[MESSAGE_ID]: 'Hook `{{name}}` should come before any test or `describe` in its scope.',
+};
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	// Stack of scopes; each tracks whether a test/suite has appeared in it yet.
+	const scopeStack = [{seenTest: false}];
+	const pushedCalls = new Set();
+
+	context.on('CallExpression', node => {
+		const parsed = parseTestCall(node, imports);
+		if (!parsed) {
+			return;
+		}
+
+		const scope = scopeStack.at(-1);
+
+		let problem;
+		if (parsed.kind === 'hook' && scope.seenTest) {
+			problem = {
+				node,
+				messageId: MESSAGE_ID,
+				data: {name: parsed.name},
+			};
+		}
+
+		if (parsed.kind === 'test' || parsed.kind === 'suite') {
+			scope.seenTest = true;
+
+			const callback = getTestCallback(node);
+			if (callback) {
+				scopeStack.push({seenTest: false});
+				pushedCalls.add(node);
+			}
+		}
+
+		return problem;
+	});
+
+	context.onExit('CallExpression', node => {
+		if (pushedCalls.has(node)) {
+			pushedCalls.delete(node);
+			scopeStack.pop();
+		}
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Require hooks to be declared before the tests in their scope.',
+			recommended: true,
+		},
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/prefer-lowercase-title.js

@@ -0,0 +1,119 @@
+import {resolveImports, parseTestCall, getTestTitle} from './utils/node-test.js';
+
+const MESSAGE_ID = 'prefer-lowercase-title';
+
+const messages = {
+	[MESSAGE_ID]: 'Start the title with a lowercase letter.',
+};
+
+/** Get the static text at the start of a title node, or `undefined` if there is none. */
+const getLeadingText = node => {
+	if (node.type === 'Literal' && typeof node.value === 'string') {
+		return node.value;
+	}
+
+	// `` `text ${x}` `` — the text before the first expression. Empty if it starts with `${…}`.
+	if (node.type === 'TemplateLiteral') {
+		return node.quasis[0].value.cooked || undefined;
+	}
+
+	return undefined;
+};
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const {sourceCode} = context;
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	const {ignore, allowedPrefixes} = context.options[0];
+
+	context.on('CallExpression', node => {
+		const parsed = parseTestCall(node, imports);
+		if (parsed?.kind !== 'test' && parsed?.kind !== 'suite') {
+			return;
+		}
+
+		if (ignore.includes(parsed.name)) {
+			return;
+		}
+
+		const titleNode = getTestTitle(node, context);
+		if (!titleNode) {
+			return;
+		}
+
+		const leadingText = getLeadingText(titleNode);
+		if (!leadingText) {
+			return;
+		}
+
+		if (allowedPrefixes.some(prefix => leadingText.startsWith(prefix))) {
+			return;
+		}
+
+		const firstCharacter = leadingText[0];
+		if (!/\p{Uppercase_Letter}/u.test(firstCharacter)) {
+			return;
+		}
+
+		const problem = {
+			node: titleNode,
+			messageId: MESSAGE_ID,
+		};
+
+		// The first content character sits right after the opening quote/backtick.
+		const start = sourceCode.getRange(titleNode)[0] + 1;
+		// Skip the fix when the first character is written as a Unicode/hex escape, so the
+		// raw source does not start with the letter itself and replacing it would corrupt the escape.
+		if (sourceCode.getText(titleNode)[1] === firstCharacter) {
+			problem.fix = fixer => fixer.replaceTextRange([start, start + 1], firstCharacter.toLowerCase());
+		}
+
+		return problem;
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Enforce lowercase test titles.',
+			recommended: false,
+		},
+		fixable: 'code',
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					ignore: {
+						type: 'array',
+						items: {
+							enum: ['test', 'it', 'describe', 'suite'],
+						},
+						uniqueItems: true,
+						description: 'Test functions whose titles are not checked.',
+					},
+					allowedPrefixes: {
+						type: 'array',
+						items: {
+							type: 'string',
+						},
+						uniqueItems: true,
+						description: 'Title prefixes that are allowed to start with an uppercase letter.',
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+		defaultOptions: [{ignore: [], allowedPrefixes: []}],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;