no-ignored-test-files add files matching

Author: jfmengels

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

@@ -1,19 +1,44 @@
 # Ensure no tests are written in ignored files
 
-When searching for tests, AVA ignores files contained in folders named `fixtures` or `helpers`.
+When searching for tests, AVA ignores files contained in folders named `fixtures` or `helpers`. By default, it will search in `test.js test-*.js test/**/*.js`, which you can override by specifying a path when launching AVA or in the [AVA configuration in the `package.json` file] ](https://github.com/sindresorhus/ava#configuration).
 
+This rule will verify that files which create tests are in the searched files and not in ignored folders.
+
+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 in the link above.
+
+Also note that this rule will not do anything if you don't have a `package.json` file in your project.
 
 ## Fail
 
 ```js
 // File: test/foo/fixtures/bar.js
+// Invalid because in `fixtures` folder
 import test from 'ava';
 
 test('foo', t => {
 	t.pass();
 });
 
 // File: test/foo/helpers/bar.js
+// Invalid because in `helpers` folder
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+
+// File: lib/foo.test.js
+// Invalid because not in the searched files
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+
+// File: test.js
+// with { "files": ["lib/**/*.test.js", "utils/**/*.test.js"] }
+// in either `package.json` under 'ava key' or in the rule options
+// Invalid because not in the searched files
 import test from 'ava';
 
 test('foo', t => {
@@ -38,4 +63,32 @@ import test from 'ava';
 test('foo', t => {
 	t.pass();
 });
+
+// File: test.js
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+
+// File: lib/foo.test.js
+// with { "files": ["lib/**/*.test.js", "utils/**/*.test.js"] }
+// in either `package.json` under 'ava key' or in the rule options
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+```
+
+## Options
+
+This rule supports the following options:
+
+`files`: An array of strings representing the files glob that AVA will use to find test files. Overrides the default and the configuration found in the `package.json` file.
+
+You can set the options like this:
+
+```js
+"ava/no-ignored-test-files": [2, {"files": ["lib/**/*.test.js", "utils/**/*.test.js"]}]
 ```

package.json

@@ -63,7 +63,9 @@
   "dependencies": {
     "deep-strict-equal": "^0.1.0",
     "espurify": "^1.5.0",
-    "object-assign": "^4.0.1"
+    "multimatch": "^2.1.0",
+    "object-assign": "^4.0.1",
+    "pkg-up": "^1.0.0"
   },
   "devDependencies": {
     "ava": "*",

rules/no-ignored-test-files.js

@@ -1,34 +1,67 @@
 'use strict';
 var path = require('path');
+var pkgUp = require('pkg-up');
+var multimatch = require('multimatch');
+var util = require('../util');
 var createAvaRule = require('../create-ava-rule');
 
-function isInIgnoredFolder(folders) {
+var defaultFiles = [
+	'test.js',
+	'test-*.js',
+	'test/**/*.js'
+];
+
+function isInIgnoredFolder(relativeFilePath) {
+	var folders = relativeFilePath.split(path.sep);
+	var ignoredFolder;
 	if (folders.indexOf('fixtures') !== -1) {
-		return 'fixtures';
+		ignoredFolder = 'fixtures';
+	} else if (folders.indexOf('helpers') !== -1) {
+		ignoredFolder = 'helpers';
 	}
 
-	if (folders.indexOf('helpers') !== -1) {
-		return 'helpers';
+	if (ignoredFolder) {
+		return 'Test file is ignored because it is inside a `' + ignoredFolder + '` folder';
 	}
 
 	return null;
 }
 
-function isIgnored(filename) {
-	var folders = filename.split(path.sep);
-	var ignoredFolder = isInIgnoredFolder(folders);
-	if (!ignoredFolder) {
-		return null;
+function isNotInGlob(files, relativeFilePath) {
+	if (multimatch([relativeFilePath], files).length === 0) {
+		return 'Test file is ignored because it is not in `' + files.join(' ') + '`';
 	}
 
-	return 'Test file is ignored because it is inside a `' + ignoredFolder + '` folder';
+	return null;
+}
+
+function isIgnored(rootDir, files, filepath) {
+	var relativeFilePath = path.relative(rootDir, filepath);
+	return isInIgnoredFolder(relativeFilePath) ||
+		isNotInGlob(files, relativeFilePath);
+}
+
+function getPackageInfo() {
+	var packageFilePath = pkgUp.sync();
+	return {
+		rootDir: packageFilePath && path.dirname(packageFilePath),
+		files: util.getAvaConfig(packageFilePath).files
+	};
 }
 
 /* eslint quote-props: [2, "as-needed"] */
 module.exports = function (context) {
 	var ava = createAvaRule();
+	var packageInfo = getPackageInfo();
+	var options = context.options[0] || {};
+	var files = options.files || packageInfo.files || defaultFiles;
 	var hasTestCall = false;
 
+	if (!packageInfo.rootDir) {
+		// Could not find a package.json folder
+		return {};
+	}
+
 	return ava.merge({
 		CallExpression: function (node) {
 			if (ava.isTestFile && ava.currentTestNode === node) {
@@ -40,11 +73,20 @@ module.exports = function (context) {
 				return;
 			}
 
-			var ignoredReason = isIgnored(context.getFilename());
+			var ignoredReason = isIgnored(packageInfo.rootDir, files, context.getFilename());
 			if (ignoredReason) {
 				context.report(node, ignoredReason);
 			}
 			hasTestCall = false;
 		}
 	});
 };
+
+module.exports.schema = [{
+	type: 'object',
+	properties: {
+		files: {
+			type: 'array'
+		}
+	}
+}];

test/no-ignored-test-files.js

@@ -1,5 +1,7 @@
+import path from 'path';
 import test from 'ava';
 import {RuleTester} from 'eslint';
+import util from '../util';
 import rule from '../rules/no-ignored-test-files';
 
 const ruleTester = new RuleTester({
@@ -9,50 +11,143 @@ const ruleTester = new RuleTester({
 });
 
 const header = `const test = require('ava');\n`;
+const rootDir = path.dirname(process.cwd());
 
-test(() => {
+function toPath(subPath) {
+	return path.join(rootDir, subPath);
+}
+
+function code(hasHeader) {
+	return (hasHeader ? header : '') + 'test(t => { t.pass(); });';
+}
+
+test('without AVA config in package.json', () => {
 	ruleTester.run('no-ignored-test-files', rule, {
 		valid: [
 			{
-				code: header + 'test(t => { t.pass(); });',
-				filename: '/foo/bar/baz.js'
+				code: code(true),
+				filename: toPath('test/foo/bar.js')
+			},
+			{
+				code: code(true),
+				filename: toPath('test/foo/not-fixtures/bar.js')
+			},
+			{
+				code: code(true),
+				filename: toPath('test/foo/not-helpers/bar.js')
 			},
 			{
-				code: header + 'test(t => { t.pass(); });',
-				filename: '/foo/not-fixtures/bar.js'
+				code: header + 'foo(t => {});',
+				filename: toPath('test/foo/fixtures/bar.js')
 			},
 			{
-				code: header + 'test(t => { t.pass(); });',
-				filename: '/foo/not-helpers/bar.js'
+				code: header + 'foo(t => {});',
+				filename: toPath('test/foo/helpers/bar.js')
 			},
 			{
-				code: header + 'foo(t => { t.pass(); });',
-				filename: '/foo/bar/fixtures/baz.js'
+				code: code(false),
+				filename: toPath('test/foo/fixtures/bar.js')
 			},
 			{
-				code: header + 'foo(t => { t.pass(); });',
-				filename: '/foo/bar/helpers/baz.js'
+				code: code(false),
+				filename: toPath('test/foo/helpers/bar.js')
 			},
 			{
-				code: 'test(t => { t.pass(); });',
-				filename: '/foo/bar/fixtures/baz.js'
+				code: code(true),
+				filename: toPath('test.js')
 			},
 			{
-				code: 'test(t => { t.pass(); });',
-				filename: '/foo/bar/helpers/baz.js'
+				code: code(true),
+				filename: toPath('test-foo.js')
+			},
+			{
+				code: code(true),
+				filename: toPath('lib/foo.test.js'),
+				options: [{files: ['lib/**/*.test.js']}]
 			}
 		],
 		invalid: [
 			{
-				code: header + 'test(t => { t.pass(); });',
-				filename: '/foo/bar/fixtures/baz.js',
+				code: code(true),
+				filename: toPath('test/foo/fixtures/bar.js'),
 				errors: [{message: 'Test file is ignored because it is inside a `fixtures` folder'}]
 			},
 			{
-				code: header + 'test(t => { t.pass(); });',
-				filename: '/foo/bar/helpers/baz.js',
+				code: code(true),
+				filename: toPath('test/foo/helpers/bar.js'),
 				errors: [{message: 'Test file is ignored because it is inside a `helpers` folder'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('lib/foo.test.js'),
+				errors: [{message: 'Test file is ignored because it is not in `test.js test-*.js test/**/*.js`'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('test/foo/bar.js'),
+				options: [{files: ['lib/**/*.test.js']}],
+				errors: [{message: 'Test file is ignored because it is not in `lib/**/*.test.js`'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('lib/foo.not-test.js'),
+				options: [{files: ['lib/**/*.test.js']}],
+				errors: [{message: 'Test file is ignored because it is not in `lib/**/*.test.js`'}]
 			}
 		]
 	});
 });
+
+test('with AVA config in package.json', () => {
+	const oldGetAvaConfig = util.getAvaConfig;
+
+	util.getAvaConfig = function mockGetAvaConfig() {
+		return {
+			files: ['lib/**/*.test.js']
+		};
+	};
+
+	ruleTester.run('no-ignored-test-files', rule, {
+		valid: [
+			{
+				code: code(true),
+				filename: toPath('lib/foo.test.js')
+			},
+			{
+				code: code(true),
+				filename: toPath('bar/foo.test.js'),
+				options: [{files: ['bar/**/*.test.js']}]
+			}
+		],
+		invalid: [
+			{
+				code: code(true),
+				filename: toPath('lib/foo/fixtures/bar.test.js'),
+				errors: [{message: 'Test file is ignored because it is inside a `fixtures` folder'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('lib/foo/helpers/bar.test.js'),
+				errors: [{message: 'Test file is ignored because it is inside a `helpers` folder'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('test.js'),
+				errors: [{message: 'Test file is ignored because it is not in `lib/**/*.test.js`'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('bar/foo.test.js'),
+				errors: [{message: 'Test file is ignored because it is not in `lib/**/*.test.js`'}]
+			},
+			{
+				code: code(true),
+				filename: toPath('lib/foo.test.js'),
+				options: [{files: ['bar/**/*.test.js']}],
+				errors: [{message: 'Test file is ignored because it is not in `bar/**/*.test.js`'}]
+			}
+		]
+	});
+
+	util.getAvaConfig = oldGetAvaConfig;
+});

util.js

@@ -1,9 +1,25 @@
 'use strict';
 
+var fs = require('fs');
+
 exports.nameOfRootObject = function (node) {
 	if (node.object.type === 'MemberExpression') {
 		return exports.nameOfRootObject(node.object);
 	}
 
 	return node.object.name;
 };
+
+exports.getAvaConfig = function (filepath) {
+	var defaultResult = {};
+	if (!filepath) {
+		return defaultResult;
+	}
+
+	try {
+		var packageContent = JSON.parse(fs.readFileSync(filepath, 'utf8'));
+		return packageContent && packageContent.ava || defaultResult;
+	} catch (e) {
+		return defaultResult;
+	}
+};