eslint-plugin-ava/rules/no-async-fn-without-await.js

ESLint rules for AVA

'use strict';

const {visitIf} = require('enhance-visitors');
const createAvaRule = require('../create-ava-rule');
const util = require('../util');

const create = context => {
	const ava = createAvaRule();
	let testUsed = false;
	let asyncTest;

	const registerUseOfAwait = () => {
		if (asyncTest) {
			testUsed = true;
		}
	};

	const isAsync = node => Boolean(node?.async);

	return ava.merge({
		CallExpression: visitIf([
			ava.isInTestFile,
			ava.isTestNode,
		])(node => {
			asyncTest = (isAsync(node.arguments[0]) && node.arguments[0])
				|| (isAsync(node.arguments[1]) && node.arguments[1]);
		}),
		AwaitExpression: registerUseOfAwait,
		YieldExpression: registerUseOfAwait,
		'ForOfStatement[await=true]': registerUseOfAwait,
		'CallExpression:exit': visitIf([
			ava.isInTestFile,
			ava.isTestNode,
		])(() => {
			if (asyncTest && !testUsed) {
				context.report({
					node: asyncTest,
					loc: {
						start: asyncTest.loc.start,
						end: asyncTest.loc.start + 5,
					},
					message: 'Function was declared as `async` but doesn\'t use `await`.',
				});
			}

			asyncTest = undefined;
			testUsed = false;
		}),
	});
};

module.exports = {
	create,
	meta: {
		type: 'suggestion',
		docs: {
			description: 'Ensure that async tests use `await`.',
			url: util.getDocsUrl(__filename),
		},
		schema: [],
	},
};