Add support for ava.config.js (#192)

Henri · novemberborn · sindresorhus · commit 6a6706ee890c · 2018-07-15T01:27:21.000+07:00
Adds support for checking the `ava.config.js` when there is no `ava` config inside `package.json`. This uses the `esm` module for parsing the config file. Fixes #191 Co-authored-by: Mark Wubben <mark@novemberborn.net>
diff --git a/docs/rules/no-ignored-test-files.md b/docs/rules/no-ignored-test-files.md
@@ -2,7 +2,7 @@
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/related/eslint-plugin-ava/docs/rules/no-ignored-test-files.md)
 
-When searching for tests, AVA ignores files contained in `node_modules` or folders named `fixtures` or `helpers`. By default, it will search in `test.js test-*.js test/**/*.js **/__tests__/**/*.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).
+When searching for tests, AVA ignores files contained in `node_modules` or folders named `fixtures` or `helpers`. By default, it will search in `test.js test-*.js test/**/*.js **/__tests__/**/*.js **/*.test.js`, which you can override by specifying a path when launching AVA or in the [AVA configuration in the `package.json` or `ava.config.js` files](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. It will consider the root of the project to be the closest folder containing a `package.json` file, and will not do anything if it can't find one. Test files in `node_modules` will not be linted as they are ignored by ESLint.
 
@@ -85,7 +85,7 @@ test('foo', t => {
 
 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.
+`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` or `ava.config.js` files.
 
 You can set the options like this:
 
diff --git a/package.json b/package.json
@@ -33,9 +33,11 @@
 		"arrify": "^1.0.1",
 		"deep-strict-equal": "^0.2.0",
 		"enhance-visitors": "^1.0.0",
+		"esm": "^3.0.69",
 		"espree": "^4.0.0",
 		"espurify": "^1.5.0",
 		"import-modules": "^1.1.0",
+		"is-plain-object": "^2.0.4",
 		"multimatch": "^2.1.0",
 		"pkg-up": "^2.0.0"
 	},
diff --git a/test/fixtures/load-config/factory-no-plain-return/ava.config.js b/test/fixtures/load-config/factory-no-plain-return/ava.config.js
@@ -0,0 +1,3 @@
+class Config {}
+
+export default () => new Config();
diff --git a/test/fixtures/load-config/factory-no-plain-return/package.json b/test/fixtures/load-config/factory-no-plain-return/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/factory-no-promise-return/ava.config.js b/test/fixtures/load-config/factory-no-promise-return/ava.config.js
@@ -0,0 +1,5 @@
+export default () => new Promise(resolve => {
+	resolve({
+		files: 'this-should-not-work'
+	});
+});
diff --git a/test/fixtures/load-config/factory-no-promise-return/package.json b/test/fixtures/load-config/factory-no-promise-return/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/no-default-export/ava.config.js b/test/fixtures/load-config/no-default-export/ava.config.js
@@ -0,0 +1 @@
+export const config = {}; // eslint-disable-line import/prefer-default-export
diff --git a/test/fixtures/load-config/no-default-export/package.json b/test/fixtures/load-config/no-default-export/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/no-plain-config/ava.config.js b/test/fixtures/load-config/no-plain-config/ava.config.js
@@ -0,0 +1 @@
+export default 'should not work!';
diff --git a/test/fixtures/load-config/no-plain-config/package.json b/test/fixtures/load-config/no-plain-config/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/no-promise-config/ava.config.js b/test/fixtures/load-config/no-promise-config/ava.config.js
@@ -0,0 +1 @@
+export default Promise.resolve('should not work!');
diff --git a/test/fixtures/load-config/no-promise-config/package.json b/test/fixtures/load-config/no-promise-config/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/package-no-file-yes-factory/ava.config.js b/test/fixtures/load-config/package-no-file-yes-factory/ava.config.js
@@ -0,0 +1,5 @@
+export default ({projectDir}) => {
+	return {
+		files: projectDir
+	};
+};
diff --git a/test/fixtures/load-config/package-no-file-yes-factory/package.json b/test/fixtures/load-config/package-no-file-yes-factory/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/package-no-file-yes/ava.config.js b/test/fixtures/load-config/package-no-file-yes/ava.config.js
@@ -0,0 +1,5 @@
+const config = {
+	files: 'config-file-esm-test-value'
+};
+
+export default config;
diff --git a/test/fixtures/load-config/package-no-file-yes/package.json b/test/fixtures/load-config/package-no-file-yes/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/load-config/package-only/package.json b/test/fixtures/load-config/package-only/package.json
@@ -0,0 +1,6 @@
+{
+	"ava": {
+		"failFast": true,
+		"concurrency": 10
+	}
+}
diff --git a/test/fixtures/load-config/package-yes-file-yes/ava.config.js b/test/fixtures/load-config/package-yes-file-yes/ava.config.js
@@ -0,0 +1,3 @@
+export default {
+	files: 'package-yes-files-yes-test-value'
+};
diff --git a/test/fixtures/load-config/package-yes-file-yes/package.json b/test/fixtures/load-config/package-yes-file-yes/package.json
@@ -0,0 +1,8 @@
+{
+	"ava": {
+		"files": [
+			"abc",
+			"!xyz"
+		]
+	}
+}
diff --git a/test/fixtures/load-config/throws/ava.config.js b/test/fixtures/load-config/throws/ava.config.js
@@ -0,0 +1 @@
+throw new Error('foo');
diff --git a/test/fixtures/load-config/throws/package.json b/test/fixtures/load-config/throws/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/util.js b/test/util.js
@@ -1,7 +1,10 @@
+import path from 'path';
 import test from 'ava';
 import util from '../util';
 import pkg from '../package';
 
+const buildPackageFilepath = fixture => path.join(__dirname, 'fixtures', 'load-config', fixture, 'package.json');
+
 test('returns the URL of the a named rule\'s documentation', t => {
 	const url = `https://github.com/avajs/eslint-plugin-ava/blob/v${pkg.version}/docs/rules/foo.md`;
 	t.is(util.getDocsUrl('foo.js'), url);
@@ -16,3 +19,46 @@ test('determines the rule name from the file', t => {
 	const url = `https://github.com/avajs/eslint-plugin-ava/blob/v${pkg.version}/docs/rules/util.md`;
 	t.is(util.getDocsUrl(__filename), url);
 });
+
+test('finds config in package.json', t => {
+	const conf = util.getAvaConfig(buildPackageFilepath('package-only'));
+	t.is(conf.failFast, true);
+});
+
+test('returns an empty object if both configs are present', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('package-yes-file-yes')), {});
+});
+
+test('loads config from file with `export default` syntax', t => {
+	const conf = util.getAvaConfig(buildPackageFilepath('package-no-file-yes'));
+	t.is(conf.files, 'config-file-esm-test-value');
+});
+
+test('loads config from factory function', t => {
+	const conf = util.getAvaConfig(buildPackageFilepath('package-no-file-yes-factory'));
+	t.true(conf.files.startsWith(__dirname));
+});
+
+test('returns an empty object if a config factory returns a promise', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('factory-no-promise-return')), {});
+});
+
+test('returns an empty object if a config exports a promise', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('no-promise-config')), {});
+});
+
+test('returns an empty object if a config factory does not return a plain object', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('factory-no-plain-return')), {});
+});
+
+test('returns an empty object if a config does not export a plain object', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('no-plain-config')), {});
+});
+
+test('returns an empty object if the ava.config.js file throws', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('throws')), {});
+});
+
+test('returns an empty object if a config file has no default export', t => {
+	t.deepEqual(util.getAvaConfig(buildPackageFilepath('no-default-export')), {});
+});
diff --git a/util.js b/util.js
@@ -1,7 +1,12 @@
 'use strict';
 const fs = require('fs');
 const path = require('path');
+const isPlainObject = require('is-plain-object');
 const pkg = require('./package');
+const esmRequire = require('esm')(module, {
+	cjs: false,
+	mode: 'all'
+});
 
 const functionExpressions = [
 	'FunctionExpression',
@@ -24,16 +29,53 @@ exports.isInContext = node => {
 	return node.property.name === 'context';
 };
 
-exports.getAvaConfig = filepath => {
+const NO_SUCH_FILE = Symbol('no ava.config.js file');
+const MISSING_DEFAULT_EXPORT = Symbol('missing default export');
+
+// Based on https://github.com/avajs/ava/blob/v1.0.0-beta.6/lib/load-config.js,
+// except where AVA would exit with an exception, this function returns an empty
+// config object.
+exports.getAvaConfig = packageFilepath => {
 	const defaultResult = {};
 
-	if (!filepath) {
+	if (!packageFilepath) {
 		return defaultResult;
 	}
 
 	try {
-		const packageContent = JSON.parse(fs.readFileSync(filepath, 'utf8'));
-		return (packageContent && packageContent.ava) || defaultResult;
+		const {ava: packageConf = defaultResult} = JSON.parse(fs.readFileSync(packageFilepath, 'utf8'));
+
+		const projectDir = path.dirname(packageFilepath);
+		let fileConf;
+		try {
+			({default: fileConf = MISSING_DEFAULT_EXPORT} = esmRequire(path.join(projectDir, 'ava.config.js')));
+		} catch (err) {
+			if (err && err.code === 'MODULE_NOT_FOUND') {
+				fileConf = NO_SUCH_FILE;
+			} else {
+				return defaultResult;
+			}
+		}
+
+		if (fileConf === MISSING_DEFAULT_EXPORT) {
+			return defaultResult
+		}
+
+		if (fileConf === NO_SUCH_FILE) {
+			return packageConf;
+		}
+
+		if (Object.keys(packageConf).length > 0) {
+			return defaultResult;
+		}
+
+		if (typeof fileConf === 'function') {
+			fileConf = fileConf({projectDir});
+		}
+
+		return !fileConf || typeof fileConf.then === 'function' || !isPlainObject(fileConf) ?
+			defaultResult :
+			fileConf;
 	} catch (_) {
 		return defaultResult;
 	}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+class Config {}`
	`2`	`+`
	`3`	`+export default () => new Config();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const config = {}; // eslint-disable-line import/prefer-default-export`