eslint-plugin-ava/rules/no-import-test-files.js

ESLint rules for AVA

'use strict';

const path = require('node:path');
const util = require('../util');

// Assume absolute paths can be classified by AVA.
const isFileImport = name => path.isAbsolute(name) || name.startsWith('./') || name.startsWith('../');

const create = context => {
	const filename = context.getFilename();
	const [overrides] = context.options;

	if (filename === '<input>' || filename === '<text>') {
		return {};
	}

	const resolveFrom = path.dirname(filename);

	let loadedAvaHelper = false;
	let avaHelper;

	const validateImportPath = (node, importPath) => {
		if (!importPath || typeof importPath !== 'string') {
			return;
		}

		if (!isFileImport(importPath)) {
			return;
		}

		if (!loadedAvaHelper) {
			avaHelper = util.loadAvaHelper(filename, overrides);
			loadedAvaHelper = true;
		}

		if (!avaHelper) {
			return {};
		}

		const {isTest} = avaHelper.classifyImport(path.resolve(resolveFrom, importPath));
		if (isTest) {
			context.report({
				node,
				message: 'Test files should not be imported.',
			});
		}
	};

	return {
		ImportDeclaration(node) {
			validateImportPath(node, node.source.value);
		},
		CallExpression(node) {
			if (!(node.callee.type === 'Identifier' && node.callee.name === 'require')) {
				return;
			}

			if (node.arguments[0]) {
				validateImportPath(node, node.arguments[0].value);
			}
		},
	};
};

const schema = [{
	type: 'object',
	properties: {
		extensions: {
			type: 'array',
		},
		files: {
			type: 'array',
		},
	},
}];

module.exports = {
	create,
	meta: {
		type: 'suggestion',
		docs: {
			description: 'Ensure no test files are imported anywhere.',
			url: util.getDocsUrl(__filename),
		},
		schema,
	},
};