Make the no-import-test rule take into account AVA extensions and babel config (#225)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: GMartigny

docs/rules/no-import-test-files.md

@@ -6,6 +6,7 @@ This rule will verify that you don't import any test files. It will consider the
 
 Note that this rule will not be able to warn correctly if you use AVA by specifying the files in the command line ( `ava "lib/**/*.test.js"` ). Prefer configuring AVA as described [here](https://github.com/avajs/ava/blob/master/docs/06-configuration.md).
 
+
 ## Fail
 
 ```js
@@ -26,16 +27,28 @@ test('foo', t => {
 
 ```js
 // File: utils/index.js
-// with { "files": ["lib/**/*.test.js", "utils/**/*.test.js"] }
-// in either `package.json` under 'ava key' or in the rule options
-// Invalid because the imported file matches lib/**/*.test.js
+// with `{"files": ["lib/**/*.test.js", "utils/**/*.test.js"]}`
+// in either `package.json` under the `"ava"` key or in the rule options
+// Invalid because the imported file matches `lib/**/*.test.js`
 import tests from '../lib/index.test.js';
 
 test('foo', t => {
 	t.pass();
 });
 ```
 
+```js
+// File: utils/index.js
+// with `{"extensions": ["js", "mjs"]}`
+// in either `package.json` under the `"ava"` key or in the rule options
+// Invalid because the imported file extension matches `mjs`
+import tests from 'index.test.mjs';
+
+test('foo', t => {
+	t.pass();
+});
+```
+
 
 ## Pass
 
@@ -52,11 +65,19 @@ import utils from './utils';
 
 ```js
 // File: lib/index.js
-// with { "files": ["lib/**/*.test.js", "utils/**/*.test.js"] }
+// with `{"files": ["lib/**/*.test.js", "utils/**/*.test.js"]}`
 // in either `package.json` under 'ava key' or in the rule options
-import utils from '../utils/index.js';
+import utils from 'test.js';
 ```
 
+```js
+// File: lib/index.js
+// `with {"extensions": ["js", "mjs"]}`
+// in either `package.json` under 'ava key' or in the rule options
+import utils from 'test.jsx';
+```
+
+
 ## Options
 
 This rule supports the following options:
@@ -65,6 +86,24 @@ This rule supports the following options:
 
 You can set the options like this:
 
-```js
+```json
 "ava/no-ignored-test-files": ["error", {"files": ["lib/**/*.test.js", "utils/**/*.test.js"]}]
 ```
+
+`extensions`: An array of strings representing the file extensions that AVA will use to find the test files. It overrides the default and the configuration found in the `package.json` or `ava.config.js` files.
+
+This extension will filter out files from the `files` option.
+
+You can set the options like this:
+
+```json
+"ava/no-ignored-test-files": [
+	"error",
+	{
+		"extensions": [
+			"js",
+			"mjs"
+		]
+	}
+]
+```

rules/no-import-test-files.js

@@ -10,23 +10,28 @@ function isExternalModule(name) {
 	return externalModuleRegExp.test(name);
 }
 
-function isTestFile(files, rootDir, sourceFile, importedFile) {
+function isTestFile(files, extensions, rootDir, sourceFile, importedFile) {
 	const absoluteImportedPath = path.resolve(path.dirname(sourceFile), importedFile);
 	const relativePath = path.relative(rootDir, absoluteImportedPath);
 
-	return multimatch([relativePath], files).length === 1;
+	return multimatch([relativePath], files).filter(file => {
+		const extension = path.extname(file).slice(1);
+		return extensions.includes(extension);
+	}).length === 1;
 }
 
 function getProjectInfo() {
 	const packageFilePath = pkgUp.sync();
+	const {files, babel} = util.getAvaConfig(packageFilePath);
 
 	return {
 		rootDir: packageFilePath && path.dirname(packageFilePath),
-		files: util.getAvaConfig(packageFilePath).files
+		files,
+		babel
 	};
 }
 
-function createImportValidator(context, files, projectInfo, filename) {
+function createImportValidator(context, files, extensions, projectInfo, filename) {
 	return (node, importPath) => {
 		if (!importPath || typeof importPath !== 'string') {
 			return;
@@ -37,7 +42,7 @@ function createImportValidator(context, files, projectInfo, filename) {
 			return;
 		}
 
-		const isImportingTestFile = isTestFile(files, projectInfo.rootDir, filename, importPath);
+		const isImportingTestFile = isTestFile(files, extensions, projectInfo.rootDir, filename, importPath);
 		if (isImportingTestFile) {
 			context.report({
 				node,
@@ -56,14 +61,17 @@ const create = context => {
 
 	const projectInfo = getProjectInfo();
 	const options = context.options[0] || {};
+
+	const extensions = arrify(options.extensions || (projectInfo.babel && projectInfo.babel.extensions) || util.defaultExtensions);
+
 	const files = arrify(options.files || projectInfo.files || util.defaultFiles);
 
 	if (!projectInfo.rootDir) {
 		// Could not find a package.json folder
 		return {};
 	}
 
-	const validateImportPath = createImportValidator(context, files, projectInfo, filename);
+	const validateImportPath = createImportValidator(context, files, extensions, projectInfo, filename);
 
 	return {
 		ImportDeclaration: node => {

test/no-import-test-files.js

@@ -18,9 +18,15 @@ const toPath = subPath => path.join(rootDir, subPath);
 
 util.getAvaConfig = () => ({
 	files: [
-		'lib/*.test.js',
+		'lib/*.test.*',
 		'test/**/*.js'
-	]
+	],
+	babel: {
+		extensions: [
+			'js',
+			'jsx'
+		]
+	}
 });
 
 const errors = [
@@ -35,9 +41,11 @@ ruleTester.run('no-import-test-files', rule, {
 		'const test = require(\'ava\');',
 		'console.log()',
 		'const value = require(somePath);',
-		'var highlight = require(\'highlight.js\')',
+		// Ok because not a valid extension
+		'import test from \'./foo.test.mjs\';',
+		'const highlight = require(\'highlight.js\')',
 		{
-			code: 'var highlight = require(\'highlight.js\')',
+			code: 'const highlight = require(\'highlight.js\')',
 			filename: toPath('test/index.js')
 		},
 		'const value = require(true);',
@@ -58,6 +66,11 @@ ruleTester.run('no-import-test-files', rule, {
 			code: 'import test from \'./bar.js\';',
 			filename: toPath('test/foo.js'),
 			errors
+		},
+		{
+			code: 'import test from \'./foo.test.jsx\';',
+			filename: toPath('lib/foo.js'),
+			errors
 		}
 	]
 });

util.js

@@ -22,6 +22,10 @@ const defaultFiles = [
 	'**/*.test.js'
 ];
 
+const defaultExtensions = [
+	'js'
+];
+
 exports.getRootNode = node => {
 	if (node.object.type === 'MemberExpression') {
 		return exports.getRootNode(node.object);
@@ -174,5 +178,6 @@ const assertionMethodNames = [...assertionMethodsNumArguments.keys()];
 
 exports.assertionMethodsNumArguments = assertionMethodsNumArguments;
 exports.defaultFiles = defaultFiles;
+exports.defaultExtensions = defaultExtensions;
 exports.assertionMethods = new Set(assertionMethodNames);
 exports.executionMethods = new Set(assertionMethodNames.concat(['end', 'plan', 'log']));