@cjser/eslint-node-test 0.2.0-cjser.2

package/rules/prefer-todo.js

@@ -0,0 +1,98 @@
+import {
+	resolveImports,
+	parseTestCall,
+	getTestCallback,
+	getTestOptions,
+	getTestTitle,
+} from './utils/node-test.js';
+import {removeArgument} from './fix/index.js';
+
+const MESSAGE_ID_ERROR = 'prefer-todo/error';
+const MESSAGE_ID_SUGGESTION = 'prefer-todo/suggestion';
+
+const messages = {
+	[MESSAGE_ID_ERROR]: 'Empty placeholder test. Use `.todo` to mark it as unfinished.',
+	[MESSAGE_ID_SUGGESTION]: 'Mark as `.todo`.',
+};
+
+/** @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);
+		// Only plain tests (a placeholder suite is a different concept); an existing modifier is intentional.
+		if (parsed?.kind !== 'test' || parsed.modifiers.length > 0) {
+			return;
+		}
+
+		// A `.todo` needs a title to be meaningful.
+		if (!getTestTitle(node, context)) {
+			return;
+		}
+
+		// An options object (`test('title', {skip: true}, …)`) marks intent, so leave it alone.
+		if (getTestOptions(node)) {
+			return;
+		}
+
+		const callback = getTestCallback(node);
+
+		// `test('title')` — only a title, no implementation.
+		const isTitleOnly = !callback && node.arguments.length === 1;
+
+		// `test('title', () => {})` — an empty implementation body.
+		const hasEmptyBody = callback?.body.type === 'BlockStatement' && callback.body.body.length === 0;
+
+		if (!isTitleOnly && !hasEmptyBody) {
+			return;
+		}
+
+		const {callee} = node;
+		// Dropping the function would drop any comments inside its body, so skip the fix then.
+		const canFix = !callback || sourceCode.getCommentsInside(callback).length === 0;
+
+		const problem = {
+			node,
+			messageId: MESSAGE_ID_ERROR,
+		};
+
+		if (canFix) {
+			problem.suggest = [
+				{
+					messageId: MESSAGE_ID_SUGGESTION,
+					* fix(fixer) {
+						yield fixer.insertTextAfter(callee, '.todo');
+						if (callback) {
+							yield removeArgument(fixer, callback, context);
+						}
+					},
+				},
+			];
+		}
+
+		return problem;
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Prefer `.todo` for empty placeholder tests.',
+			recommended: true,
+		},
+		hasSuggestions: true,
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/require-assertion.js

@@ -0,0 +1,99 @@
+import {
+	resolveImports,
+	parseTestCall,
+	getTestCallback,
+	parseAssertionCall,
+	createContextTracker,
+	isAssertionCallWithSupportedContext,
+} from './utils/node-test.js';
+
+const MESSAGE_ID = 'require-assertion/error';
+
+const messages = {
+	[MESSAGE_ID]: 'Test is missing an assertion. Tests without assertions will always pass.',
+};
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	/*
+	Stack of {callNode, callback, hasAssertion} for each open test call.
+	We push when we enter a test call with an inline callback, and pop (and possibly report) on exit.
+	*/
+	const testStack = [];
+	const tracker = createContextTracker(imports);
+
+	context.on('CallExpression', node => {
+		tracker.update(node);
+
+		const parsed = parseTestCall(node, imports);
+
+		// Track nested test calls as their own scope (don't let their assertions count for parent).
+		if (parsed && parsed.kind === 'test') {
+			const callback = getTestCallback(node);
+			// Only push if there's an inline function body to inspect.
+			if (callback) {
+				testStack.push({callNode: node, callback, hasAssertion: false});
+				return;
+			}
+
+			// No inline callback: skip/todo or external implementation — don't report.
+			if (testStack.length > 0) {
+				// Mark parent as having an assertion-like (external impl may assert).
+				testStack.at(-1).hasAssertion = true;
+			}
+
+			return;
+		}
+
+		// Check if this call is an assertion.
+		if (testStack.length > 0 && parseAssertionCall(node, imports) && isAssertionCallWithSupportedContext(node, tracker)) {
+			testStack.at(-1).hasAssertion = true;
+		}
+	});
+
+	context.onExit('CallExpression', node => {
+		tracker.leave(node);
+
+		if (testStack.length === 0) {
+			return;
+		}
+
+		const top = testStack.at(-1);
+		if (top.callNode !== node) {
+			return;
+		}
+
+		testStack.pop();
+
+		if (!top.hasAssertion) {
+			return {
+				node,
+				messageId: MESSAGE_ID,
+			};
+		}
+
+		// Propagate to parent: a nested test call itself doesn't count as an assertion in the parent.
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Require that each test contains at least one assertion.',
+			recommended: true,
+		},
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/require-await-concurrent-subtests.js

@@ -0,0 +1,119 @@
+import {resolveImports, createContextTracker} from './utils/node-test.js';
+import isFunction from './ast/is-function.js';
+
+const MESSAGE_ID = 'require-await-concurrent-subtests';
+
+const messages = {
+	[MESSAGE_ID]: 'Subtests created in a `{{method}}()` callback are not awaited, so they are cancelled when the parent test finishes. Use `await Promise.all(items.map(item => t.test(…)))`.',
+};
+
+// Array methods commonly used to create one subtest per element.
+const ITERATION_METHODS = new Set(['map', 'forEach', 'flatMap']);
+
+/** Find the iteration call (`xs.map(cb)`) whose callback directly encloses `node`, or `undefined`. */
+function findEnclosingIterationCall(node) {
+	let current = node.parent;
+	while (current) {
+		if (isFunction(current)) {
+			const {parent} = current;
+			if (
+				parent?.type === 'CallExpression'
+				&& parent.callee.type === 'MemberExpression'
+				&& !parent.callee.computed
+				&& parent.callee.property.type === 'Identifier'
+				&& ITERATION_METHODS.has(parent.callee.property.name)
+				&& parent.arguments.includes(current)
+			) {
+				return parent;
+			}
+
+			// Any other function is a scope boundary (the test callback or a helper).
+			return undefined;
+		}
+
+		current = current.parent;
+	}
+}
+
+/** Whether the iteration call is an argument to a consumed `Promise.all(…)` / `Promise.allSettled(…)`. */
+function isAwaitedViaPromiseAll(iterationCall) {
+	const {parent} = iterationCall;
+	if (
+		parent?.type === 'CallExpression'
+		&& parent.callee.type === 'MemberExpression'
+		&& !parent.callee.computed
+		&& parent.callee.property.type === 'Identifier'
+		&& (parent.callee.property.name === 'all' || parent.callee.property.name === 'allSettled')
+		&& parent.callee.object.type === 'Identifier'
+		&& parent.callee.object.name === 'Promise'
+		&& parent.arguments.includes(iterationCall)
+	) {
+		// The `Promise.all(…)` itself must be consumed (awaited, returned, or assigned), not discarded —
+		// otherwise the parent test still finishes before the subtests settle. It is discarded when left
+		// as a floating bare statement or explicitly thrown away with `void`.
+		const {parent: grandparent} = parent;
+		const isDiscarded = grandparent?.type === 'ExpressionStatement'
+			|| (grandparent?.type === 'UnaryExpression' && grandparent.operator === 'void');
+		return !isDiscarded;
+	}
+
+	return false;
+}
+
+/** @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 => {
+		const isSubtest = tracker.isSubtestCall(node);
+
+		let problem;
+		// A bare-statement subtest is already covered by `no-unawaited-subtest`; this rule covers the
+		// expression-body and `return` forms inside an iteration callback that it misses.
+		if (isSubtest && node.parent?.type !== 'ExpressionStatement') {
+			const iterationCall = findEnclosingIterationCall(node);
+			if (iterationCall) {
+				const method = iterationCall.callee.property.name;
+				// `forEach` discards its callbacks' results entirely; `map`/`flatMap` are fine only when
+				// the resulting array is awaited via `Promise.all`.
+				const handled = method !== 'forEach' && isAwaitedViaPromiseAll(iterationCall);
+				if (!handled) {
+					problem = {
+						node,
+						messageId: MESSAGE_ID,
+						data: {method},
+					};
+				}
+			}
+		}
+
+		tracker.update(node);
+		return problem;
+	});
+
+	context.onExit('CallExpression', node => {
+		tracker.leave(node);
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Require subtests created in a loop callback to be awaited.',
+			recommended: 'unopinionated',
+		},
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/require-context-assert-with-plan.js

@@ -0,0 +1,127 @@
+import {
+	resolveImports,
+	parseTestCall,
+	parseAssertionCall,
+	createContextTracker,
+} from './utils/node-test.js';
+
+const MESSAGE_ID = 'require-context-assert-with-plan';
+
+const messages = {
+	[MESSAGE_ID]: 'This assertion is not counted by `{{context}}.plan()`. Use `{{context}}.assert` so the runner counts it toward the plan.',
+};
+
+/** Get the context name of a `<context>.plan(…)` call, or `undefined`. */
+function getPlanContextName(node) {
+	const {callee} = node;
+	if (
+		callee.type === 'MemberExpression'
+		&& !callee.computed
+		&& callee.property.type === 'Identifier'
+		&& callee.property.name === 'plan'
+		&& callee.object.type === 'Identifier'
+	) {
+		return callee.object.name;
+	}
+
+	return undefined;
+}
+
+/** Whether a call is the `<context>.assert.method(…)` form, which the plan does count. */
+function isContextAssertCall(node, tracker) {
+	const {callee} = node;
+	return (
+		callee.type === 'MemberExpression'
+		&& callee.object.type === 'MemberExpression'
+		&& !callee.object.computed
+		&& callee.object.property.type === 'Identifier'
+		&& callee.object.property.name === 'assert'
+		&& callee.object.object.type === 'Identifier'
+		&& tracker.isContextName(callee.object.object.name)
+	);
+}
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const imports = resolveImports(context);
+	// Without a `node:assert` import the only assertions are `t.assert.*` (which count toward the
+	// plan and are excluded below), so there is nothing to report.
+	if (!imports.isTestFile || !imports.hasAssert) {
+		return;
+	}
+
+	const tracker = createContextTracker(imports);
+
+	// One frame per enclosing test/subtest. Assertions attach to the innermost; the frame is
+	// reported only if its test called `plan()`.
+	const frames = [];
+
+	context.on('CallExpression', node => {
+		const isTest = parseTestCall(node, imports)?.kind === 'test' || tracker.isSubtestCall(node);
+		tracker.update(node);
+
+		if (isTest) {
+			frames.push({
+				node, contextName: tracker.current(), hasPlan: false, assertions: [],
+			});
+			return;
+		}
+
+		if (frames.length === 0) {
+			return;
+		}
+
+		const planContextName = getPlanContextName(node);
+		if (planContextName !== undefined) {
+			// Mark the innermost frame whose test owns this context.
+			for (let index = frames.length - 1; index >= 0; index -= 1) {
+				if (frames[index].contextName === planContextName) {
+					frames[index].hasPlan = true;
+					break;
+				}
+			}
+
+			return;
+		}
+
+		if (parseAssertionCall(node, imports) && !isContextAssertCall(node, tracker)) {
+			frames.at(-1).assertions.push(node);
+		}
+	});
+
+	context.onExit('CallExpression', node => {
+		tracker.leave(node);
+
+		if (frames.at(-1)?.node !== node) {
+			return;
+		}
+
+		const frame = frames.pop();
+		if (!frame.hasPlan || frame.contextName === undefined) {
+			return;
+		}
+
+		return frame.assertions.map(assertion => ({
+			node: assertion,
+			messageId: MESSAGE_ID,
+			data: {context: frame.contextName},
+		}));
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Require assertions to use the test context when the test sets a plan.',
+			recommended: 'unopinionated',
+		},
+		schema: [],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;

package/rules/require-hook.js

@@ -0,0 +1,108 @@
+import {
+	resolveImports,
+	parseTestCall,
+	parseAssertionCall,
+	getTestCallback,
+} from './utils/node-test.js';
+import isFunction from './ast/is-function.js';
+
+const MESSAGE_ID = 'require-hook';
+
+const messages = {
+	[MESSAGE_ID]: 'This runs when the file is loaded, not as part of a test. Move it into a `before`, `beforeEach`, `after`, or `afterEach` hook.',
+};
+
+/*
+Whether the statement sits directly in a registration-time scope: the module top level or a
+`describe`/`suite` body. Statements inside a test/hook callback or a helper function are fine.
+*/
+function isInRegistrationScope(statement, imports) {
+	const {parent} = statement;
+	if (parent.type === 'Program') {
+		return true;
+	}
+
+	if (parent.type !== 'BlockStatement') {
+		return false;
+	}
+
+	const callback = parent.parent;
+	if (
+		!isFunction(callback)
+		|| callback.parent?.type !== 'CallExpression'
+		|| getTestCallback(callback.parent) !== callback
+	) {
+		return false;
+	}
+
+	return parseTestCall(callback.parent, imports)?.kind === 'suite';
+}
+
+/** @param {import('eslint').Rule.RuleContext} context */
+const create = context => {
+	const {sourceCode} = context;
+	const imports = resolveImports(context);
+	if (!imports.isTestFile) {
+		return;
+	}
+
+	const allow = new Set(context.options[0].allow);
+
+	context.on('ExpressionStatement', node => {
+		const call = node.expression;
+		if (call.type !== 'CallExpression') {
+			return;
+		}
+
+		// The test/suite/hook registration calls themselves belong here.
+		if (parseTestCall(call, imports)) {
+			return;
+		}
+
+		// Misplaced assertions are reported by `no-assert-in-describe`.
+		if (parseAssertionCall(call, imports)) {
+			return;
+		}
+
+		if (allow.has(sourceCode.getText(call.callee))) {
+			return;
+		}
+
+		if (!isInRegistrationScope(node, imports)) {
+			return;
+		}
+
+		return {node, messageId: MESSAGE_ID};
+	});
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const config = {
+	create,
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Require setup and teardown code to be inside a hook.',
+			recommended: false,
+		},
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					allow: {
+						type: 'array',
+						items: {type: 'string'},
+						uniqueItems: true,
+						description: 'Callee expressions allowed at the top level (for example, `["console.log"]`).',
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+		defaultOptions: [{allow: []}],
+		messages,
+		languages: ['js/js'],
+	},
+};
+
+export default config;