Merge v0.25.0 from original AVA code base

Author: andywer

.gitignore

@@ -3,3 +3,4 @@ node_modules
 coverage
 bench/.results
 types/generated.d.ts
+/package-lock.json.md5

.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
+  - 9
   - 8
   - 6
   - 4
@@ -8,6 +9,8 @@ env:
   - FRESH_DEPS=true
 matrix:
   exclude:
+    - node_js: 9
+      env: FRESH_DEPS=true
     - node_js: 6
       env: FRESH_DEPS=true
     - node_js: 4
@@ -16,8 +19,17 @@ cache:
   directories:
     - $HOME/.npm
 before_install:
-  - npm install --global npm@5.4.2
+  - npm install --global npm@5.6.0
   - npm --version
-install:
-  - if [[ ${FRESH_DEPS} == "true" ]]; then npm install --no-shrinkwrap --prefer-online; else npm install --prefer-offline; fi
-after_success: ./node_modules/.bin/codecov --file=./coverage/lcov.info
+  - md5sum package-lock.json > package-lock.json.md5
+install: |
+  if [[ ${FRESH_DEPS} == "true" ]]; then
+    npm install --no-shrinkwrap --prefer-online;
+  else
+    npm install --prefer-offline;
+    if ! md5sum --quiet -c package-lock.json.md5; then
+      echo "package-lock.json was modified unexpectedly. Please rebuild it using npm@$(npm -v) and commit the changes.";
+      exit 1;
+    fi
+  fi
+after_success: npx codecov --file=./coverage/lcov.info

appveyor.yml

@@ -11,19 +11,22 @@ configuration:
   - LockedDeps
 environment:
   matrix:
+    - nodejs_version: 9
     - nodejs_version: 8
     - nodejs_version: 6
     - nodejs_version: 4
 matrix:
   fast_finish: true
   exclude:
+    - configuration: FreshDeps
+      nodejs_version: 9
     - configuration: FreshDeps
       nodejs_version: 6
     - configuration: FreshDeps
       nodejs_version: 4
 install:
   - ps: Install-Product node $env:nodejs_version
-  - npm install --global npm@5.4.2
+  - npm install --global npm@5.6.0
   - npm --version
   - git config core.symlinks true
   - git reset --hard

cli.js

@@ -8,7 +8,7 @@ if (importLocal(__filename)) {
 	debug('Using local install of AVA');
 } else {
 	if (debug.enabled) {
-		require('time-require'); // eslint-disable-line import/no-unassigned-import
+		require('@ladjs/time-require'); // eslint-disable-line import/no-unassigned-import
 	}
 
 	try {

docs/common-pitfalls.md

@@ -75,6 +75,10 @@ test(t => {
 });
 ```
 
+### Helpers are not compiled when using a non-default test folder
+
+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/babelrc.md

@@ -36,6 +36,8 @@ You can override the default Babel configuration AVA uses for test transpilation
 }
 ```
 
+Note that this only affects how AVA transpiles your tests. If you use `babel-register` you'll still need to add separate Babel configuration as explained [here](#transpiling-sources).
+
 ## Use Babel Polyfills
 
 AVA lets you write your tests using new JavaScript syntax, even on Node.js versions that otherwise wouldn't support it. However, it doesn't add or modify built-ins of your current environment. Using AVA would, for example, not provide modern features such as `Array.prototype.includes()` to an underlying Node.js 4 environment.

docs/recipes/debugging-with-vscode.md

@@ -18,6 +18,9 @@ Add following to the `configurations` object:
 	"program": "${workspaceRoot}/node_modules/ava/profile.js",
 	"args": [
 	  "${file}"
+	],
+	"skipFiles": [
+		"<node_internals>/**/*.js"
 	]
 }
 ```
@@ -33,3 +36,25 @@ Save this configuration after you added it.
 Set breakpoints in the code **or** write `debugger;` at the point where it should stop.
 
 Hit the green `Debug` button next to the list of configurations on the top left in the `Debug` view. Once the breakpoint is hit, you can evaluate variables and step through the code.
+
+## Serial debugging
+
+By default AVA runs tests concurrently. This may complicate debugging. Add a configuration with the `--serial` argument so AVA runs only one test at a time:
+
+```json
+{
+	"type": "node",
+	"request": "launch",
+	"name": "Run AVA test serially",
+	"program": "${workspaceRoot}/node_modules/ava/profile.js",
+	"args": [
+	  "--serial",
+	  "${file}"
+	],
+	"skipFiles": [
+		"<node_internals>/**/*.js"
+	]
+}
+```
+
+*Note that, if your tests aren't properly isolated, certain test failures may not appear when running the tests serially.*

docs/recipes/precompiling-with-webpack.md

@@ -222,7 +222,7 @@ npm scripts:
 {
 	"scripts": {
 		"precompile-src": "cross-env NODE_ENV=test babel src --out-dir _src",
-		"precompile-tests": "cross-env NODE_ENV=test webpack --config webpack.config.test.js",
+		"precompile-tests": "cross-env NODE_ENV=test webpack --config webpack.config.js",
 		"pretest": "npm run precompile-src && npm run precompile-tests",
 		"test": "cross-env NODE_ENV=test nyc --cache ava _build"
 	}

index.js.flow

@@ -84,7 +84,7 @@ type TestContext = AssertContext & {
 	title: string;
 	plan(count: number): void;
 	skip: AssertContext;
-	log(message: string): void;
+	log(...values: Array<any>): void;
 };
 type ContextualTestContext         = TestContext & { context: any; };
 type ContextualCallbackTestContext = TestContext & { context: any; end(): void; };

lib/assert.js

@@ -49,14 +49,22 @@ class AssertionError extends Error {
 
 		if (opts.stack) {
 			this.stack = opts.stack;
+		} else {
+			const limitBefore = Error.stackTraceLimit;
+			Error.stackTraceLimit = Infinity;
+			Error.captureStackTrace(this);
+			Error.stackTraceLimit = limitBefore;
 		}
 	}
 }
 exports.AssertionError = AssertionError;
 
 function getStack() {
+	const limitBefore = Error.stackTraceLimit;
+	Error.stackTraceLimit = Infinity;
 	const obj = {};
 	Error.captureStackTrace(obj, getStack);
+	Error.stackTraceLimit = limitBefore;
 	return obj.stack;
 }
 
@@ -122,8 +130,16 @@ function wrapAssertions(callbacks) {
 			}
 		},
 
-		log(text) {
-			log(this, text);
+		log() {
+			const args = Array.from(arguments, value => {
+				return typeof value === 'string' ?
+					value :
+					concordance.format(value, concordanceOptions);
+			});
+
+			if (args.length > 0) {
+				log(this, args.join(' '));
+			}
 		},
 
 		deepEqual(actual, expected, message) {

lib/main.js

@@ -23,8 +23,6 @@ worker.setRunner(runner);
 // that no more tests should be logged
 let isFailed = false;
 
-Error.stackTraceLimit = Infinity;
-
 function test(props) {
 	if (isFailed) {
 		return;

lib/process-adapter.js

@@ -48,13 +48,13 @@ if (opts.tty) {
 }
 
 if (debug.enabled) {
-	// Forward the `time-require` `--sorted` flag.
+	// Forward the `@ladjs/time-require` `--sorted` flag.
 	// Intended for internal optimization tests only.
 	if (opts._sorted) {
 		process.argv.push('--sorted');
 	}
 
-	require('time-require'); // eslint-disable-line import/no-unassigned-import
+	require('@ladjs/time-require'); // eslint-disable-line import/no-unassigned-import
 }
 
 const sourceMapCache = new Map();

lib/reporters/tap.js

@@ -1,8 +1,6 @@
 'use strict';
-const format = require('util').format;
-const indentString = require('indent-string');
+const supertap = require('supertap');
 const stripAnsi = require('strip-ansi');
-const yaml = require('js-yaml');
 
 function dumpError(error, includeMessage) {
 	const obj = Object.assign({}, error.object);
@@ -32,7 +30,7 @@ function dumpError(error, includeMessage) {
 		obj.at = error.stack.split('\n')[0];
 	}
 
-	return `  ---\n${indentString(yaml.safeDump(obj).trim(), 4)}\n  ...`;
+	return obj;
 }
 
 class TapReporter {
@@ -41,79 +39,42 @@ class TapReporter {
 	}
 
 	start() {
-		return 'TAP version 13';
+		return supertap.start();
 	}
 
 	test(test) {
-		const output = [];
-
-		let directive = '';
-		const passed = test.todo ? 'not ok' : 'ok';
-
-		if (test.todo) {
-			directive = '# TODO';
-		} else if (test.skip) {
-			directive = '# SKIP';
-		}
-
-		const title = stripAnsi(test.title);
-
-		const appendLogs = () => {
-			if (test.logs) {
-				test.logs.forEach(log => {
-					const logLines = indentString(log, 4);
-					const logLinesWithLeadingFigure = logLines.replace(
-						/^ {4}/,
-						'  * '
-					);
-
-					output.push(logLinesWithLeadingFigure);
-				});
-			}
-		};
-
-		output.push(`# ${title}`);
-
-		if (test.error) {
-			output.push(format('not ok %d - %s', ++this.i, title));
-			appendLogs();
-			output.push(dumpError(test.error, true));
-		} else {
-			output.push(format('%s %d - %s %s', passed, ++this.i, title, directive).trim());
-			appendLogs();
-		}
-
-		return output.join('\n');
+		return supertap.test(test.title, {
+			passed: !test.error,
+			index: ++this.i,
+			todo: test.todo,
+			skip: test.skip,
+			comment: test.logs,
+			error: test.error ? dumpError(test.error, true) : null
+		});
 	}
 
 	unhandledError(err) {
-		const output = [
-			`# ${err.message}`,
-			format('not ok %d - %s', ++this.i, err.message)
-		];
+		let error;
+
 		// AvaErrors don't have stack traces
 		if (err.type !== 'exception' || err.name !== 'AvaError') {
-			output.push(dumpError(err, false));
+			error = dumpError(err, false);
 		}
 
-		return output.join('\n');
+		return supertap.test(err.message, {
+			passed: false,
+			index: ++this.i,
+			error
+		});
 	}
 
 	finish(runStatus) {
-		const output = [
-			'',
-			'1..' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
-			'# tests ' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
-			'# pass ' + runStatus.passCount
-		];
-
-		if (runStatus.skipCount > 0) {
-			output.push(`# skip ${runStatus.skipCount}`);
-		}
-
-		output.push('# fail ' + (runStatus.failCount + runStatus.rejectionCount + runStatus.exceptionCount), '');
-
-		return output.join('\n');
+		return supertap.finish({
+			passed: runStatus.passCount,
+			failed: runStatus.failCount,
+			skipped: runStatus.skipCount,
+			crashed: runStatus.rejectionCount + runStatus.exceptionCount
+		});
 	}
 
 	write(str) {

lib/test-worker.js

@@ -28,7 +28,14 @@ globals.options = opts;
 const serializeError = require('./serialize-error');
 
 process.env.TS_NODE_TYPE_CHECK = true;
-(opts.require || []).forEach(x => require(x));
+
+(opts.require || []).forEach(x => {
+	if (/[/\\]@std[/\\]esm[/\\]index\.js$/.test(x)) {
+		require = require(x)(module); // eslint-disable-line no-global-assign
+	} else {
+		require(x);
+	}
+});
 
 adapter.installSourceMapSupport();
 adapter.installPrecompilerHook();