fixup! fixup! wip! Refactor glob handling

Author: novemberborn

docs/05-command-line.md

@@ -30,14 +30,20 @@ $ npx ava --help
 
   The above relies on your shell expanding the glob patterns.
   Without arguments, AVA uses the following patterns:
-    test.js test-*.js test/**/*.js **/__tests__/**/*.js **/*.test.js
+    **/test.js **/test-*.js **/*.test.js **/test/**/*.js **/__tests__/**/*.js
 ```
 
 *Note that the CLI will use your local install of AVA when available, even when run globally.*
 
-**FIXME**
+AVA searches for test files using the following patterns:
 
-Directories are recursed, with all `*.js` files being treated as test files. Directories named `fixtures`, `helpers` and `node_modules` are *always* ignored. So are files starting with `_` which allows you to place helpers in the same directory as your test files.
+* `**/test.js`
+* `**/test-*.js`
+* `**/*.test.js`
+* `**/test/**/*.js`
+* `**/__tests__/**/*.js`
+
+Files inside `node_modules` are *always* ignored. So are files starting with `_`. These are treated as helpers.
 
 When using `npm test`, you can pass positional arguments directly `npm test test2.js`, but flags needs to be passed like `npm test -- --verbose`.
 

docs/06-configuration.md

@@ -48,7 +48,7 @@ Arguments passed to the CLI will always take precedence over the CLI options con
 
 ## Options
 
-- `files`: **FIXME** file & directory paths and glob patterns that select which files AVA will run tests from. Files with an underscore prefix are ignored. All matched files in selected directories are run. By default only selects files with `js` extensions, even if the glob pattern matches other files. Specify `extensions` and `babel.extensions` to allow other file extensions
+- `files`: glob patterns that select which files AVA will run tests from. Files with an underscore prefix are ignored. By default only selects files with `js` extensions, even if the glob pattern matches other files. Specify `extensions` and `babel.extensions` to allow other file extensions
 - `sources`: files that, when changed, cause tests to be re-run in watch mode. See the [watch mode recipe for details](https://github.com/avajs/ava/blob/master/docs/recipes/watch-mode.md#source-files-and-test-files)
 - `match`: not typically useful in the `package.json` configuration, but equivalent to [specifying `--match` on the CLI](./05-command-line.md#running-tests-with-matching-titles)
 - `cache`: cache compiled test and helper files under `node_modules/.cache/ava`. If `false`, files are cached in a temporary directory instead
@@ -64,7 +64,7 @@ Arguments passed to the CLI will always take precedence over the CLI options con
 - `babel.extensions`: extensions of test files that will be precompiled using AVA's Babel presets. Setting this overrides the default `"js"` value, so make sure to include that extension in the list
 - `timeout`: Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our [timeout documentation](./07-test-timeouts.md) for more options.
 
-**FIXME** Note that providing files on the CLI overrides the `files` option. If you've configured a glob pattern, for instance `test/**/*.test.js`, you may want to repeat it when using the CLI: `ava 'test/integration/*.test.js'`.
+Note that providing files on the CLI overrides the `files` option.
 
 ## Using `ava.config.js`
 

docs/08-common-pitfalls.md

@@ -83,12 +83,6 @@ test('one is one', t => {
 });
 ```
 
-### Helpers are not compiled when using a non-default test folder
-
-**FIXME**
-
-This is a [known issue](https://github.com/avajs/ava/issues/1319). You should put your tests in a folder called `test` or `__tests__`.
-
 ---
 
 Is your problem not listed here? Submit a pull request or comment on [this issue](https://github.com/avajs/ava/issues/404).

docs/recipes/watch-mode.md

@@ -65,16 +65,12 @@ AVA uses [`chokidar`] as the file watcher. Note that even if you see warnings ab
 
 ## Source files and test files
 
-**FIXME**
-
 In AVA there's a distinction between *source files* and *test files*. As you can imagine the *test files* contain your tests. *Source files* are all other files that are needed for the tests to run, be it your source code or test fixtures.
 
 By default AVA watches for changes to the test files, snapshot files, `package.json`, and any other `.js` files. It'll ignore files in [certain directories](https://github.com/novemberborn/ignore-by-default/blob/master/index.js) as provided by the [`ignore-by-default`] package.
 
 You can configure patterns for the source files in the [`ava` section of your `package.json`, or `ava.config.js` file][config], using the `sources` key.
 
-You can specify patterns to match files in the folders that would otherwise be ignored, e.g. use `node_modules/some-dependency/*.js` to specify all `.js` files in `node_modules/some-dependency` as a source, even though normally all files in `node_modules` are ignored. Note that you need to specify an exact directory; `{bower_components,node_modules}/**/*.js` won't work.
-
 If your tests write to disk they may trigger the watcher to rerun your tests. Configure patterns for the source files to avoid this.
 
 ## Dependency tracking

lib/cli.js

@@ -52,7 +52,7 @@ exports.run = async () => { // eslint-disable-line complexity
 
 		The above relies on your shell expanding the glob patterns.
 		Without arguments, AVA uses the following patterns:
-			test.js test-*.js test/**/*.js **/__tests__/**/*.js **/*.test.js
+		  **/test.js **/test-*.js **/*.test.js **/test/**/*.js **/__tests__/**/*.js
 	`, {
 		flags: {
 			watch: {
@@ -250,17 +250,19 @@ exports.run = async () => { // eslint-disable-line complexity
 		});
 	});
 
+	const files = cli.input.map(file => path.resolve(process.cwd(), file));
+
 	if (conf.watch) {
 		const watcher = new Watcher({
 			api,
 			reporter,
-			files: cli.input,
+			files,
 			globs,
 			resolveTestsFrom
 		});
 		watcher.observeStdin(process.stdin);
 	} else {
-		const runStatus = await api.run(cli.input);
+		const runStatus = await api.run(files);
 		process.exitCode = runStatus.suggestExitCode({matching: match.length > 0});
 		reporter.endRun();
 	}

lib/globs.js

@@ -1,6 +1,5 @@
 'use strict';
 const path = require('path');
-const arrFlatten = require('arr-flatten');
 const globby = require('globby');
 const ignoreByDefault = require('ignore-by-default');
 const micromatch = require('micromatch');
@@ -133,9 +132,7 @@ function getChokidarPatterns({sourcePatterns, testPatterns}) {
 	const ignored = defaultIgnorePatterns.map(pattern => `${pattern}/**/*`);
 
 	for (const pattern of [...sourcePatterns, ...testPatterns]) {
-		if (pattern.startsWith('!')) {
-			ignored.push(pattern.slice(1));
-		} else {
+		if (!pattern.startsWith('!')) {
 			paths.push(pattern);
 		}
 	}
@@ -145,21 +142,36 @@ function getChokidarPatterns({sourcePatterns, testPatterns}) {
 
 exports.getChokidarPatterns = getChokidarPatterns;
 
-const matches = (file, patterns) => {
-	const ignore = [...defaultIgnorePatterns];
-	patterns = patterns.filter(pattern => {
-		if (pattern.startsWith('!')) {
-			ignore.push(pattern.slice(1));
-			return false;
-		}
+const matchingCache = new WeakMap();
+const processMatchingPatterns = input => {
+	let result = matchingCache.get(input);
+	if (!result) {
+		const ignore = [
+			...defaultIgnorePatterns,
+			// Unlike globby(), micromatch needs a complete pattern when ignoring directories.
+			...defaultIgnorePatterns.map(pattern => `${pattern}/**/*`)
+		];
+		const patterns = input.filter(pattern => {
+			if (pattern.startsWith('!')) {
+				// Unlike globby(), micromatch needs a complete pattern when ignoring directories.
+				ignore.push(pattern.slice(1), `${pattern.slice(1)}/**/*`);
+				return false;
+			}
+
+			return true;
+		});
+
+		result = {patterns, ignore};
+		matchingCache.set(input, result);
+	}
 
-		return true;
-	});
+	return result;
+};
 
-	return micromatch.some(file, patterns, {
-		// Unlike globby(), micromatch needs a complete pattern when ignoring directories.
-		ignore: arrFlatten(ignore.map(pattern => [pattern, `${pattern}/**/*`]))
-	});
+const matches = (file, patterns) => {
+	let ignore;
+	({patterns, ignore} = processMatchingPatterns(patterns));
+	return micromatch.some(file, patterns, {ignore});
 };
 
 function isSource(file, {testPatterns, sourcePatterns}) {

lib/watcher.js

@@ -374,7 +374,7 @@ class Watcher {
 
 		if (dirtySources.length === 0) {
 			// Run any new or changed tests
-			this.run(addedOrChangedTests);
+			this.run(addedOrChangedTests.map(file => nodePath.resolve(this.globs.cwd, file)));
 			return;
 		}
 
@@ -396,7 +396,7 @@ class Watcher {
 		}
 
 		// Run all affected tests
-		this.run(union(addedOrChangedTests, uniq(flatten(testsBySource))));
+		this.run(union(addedOrChangedTests, uniq(flatten(testsBySource))).map(file => nodePath.resolve(this.globs.cwd, file)));
 	}
 }
 

test/fixture/parallel-runs/package.json

@@ -0,0 +1,5 @@
+{
+	"ava": {
+		"files": ["*.js"]
+	}
+}

test/fixture/pkg-conf/resolve-dir/package.json

@@ -2,6 +2,6 @@
   "name": "application-name",
   "version": "0.0.1",
   "ava": {
-    "files": "dir-a/*.js"
+    "files": ["dir-a/*.js"]
   }
 }

test/fixture/snapshots/test-content/package.json

@@ -1,5 +1,5 @@
 {
 	"ava": {
-		"files": "tests"
+		"files": ["tests/test.js"]
 	}
 }