ava 0.18.1 → 0.18.2

package/api.js

@@ -49,12 +49,7 @@ class Api extends EventEmitter {
 		super();
 		autoBind(this);
 
-		this.options = Object.assign({
-			cwd: process.cwd(),
-			resolveTestsFrom: process.cwd(),
-			match: []
-		}, options);
-
+		this.options = Object.assign({match: []}, options);
 		this.options.require = resolveModules(this.options.require);
 	}
 	_runFile(file, runStatus, execArgv) {
@@ -119,6 +114,11 @@ class Api extends EventEmitter {
 	_precompileHelpers() {
 		this._precompiledHelpers = {};
 
+		// Assumes the tests only load helpers from within the `resolveTestsFrom`
+		// directory. Without arguments this is the `projectDir`, else it's
+		// `process.cwd()` which may be nested too deeply. This will be solved
+		// as we implement RFC 001 and move helper compilation into the worker
+		// processes, avoiding the need for precompilation.
 		return new AvaFiles({cwd: this.options.resolveTestsFrom})
 			.findTestHelpers()
 			.map(file => { // eslint-disable-line array-callback-return

package/index.js.flow

@@ -31,7 +31,7 @@ type ErrorValidator =
 	| ((error: any) => boolean);
 
 /**
- * Asertion Types
+ * Assertion Types
  */
 
 type AssertContext = {
@@ -57,13 +57,19 @@ type AssertContext = {
 	notDeepEqual<U>(value: U, expected: U, message?: string): void;
 	// Assert that function throws an error or promise rejects.
 	// @param error Can be a constructor, regex, error message or validation function.
-	throws(value: PromiseLike<mixed>, error?: ErrorValidator, message?: string): Promise<mixed>;
-	throws(value: () => void, error?: ErrorValidator, message?: string): mixed;
+	throws: {
+		(value: PromiseLike<mixed>, error?: ErrorValidator, message?: string): Promise<Error>;
+		(value: () => mixed, error?: ErrorValidator, message?: string): Error;
+	};
 	// Assert that function doesn't throw an error or promise resolves.
-	notThrows<U>(value: PromiseLike<U>, message?: string): Promise<U>;
-	notThrows(value: () => void, message?: string): void;
+	notThrows: {
+		<U>(value: PromiseLike<U>, message?: string): Promise<U>;
+		(value: () => mixed, message?: string): void;
+	};
 	// Assert that contents matches regex.
 	regex(contents: string, regex: RegExp, message?: string): void;
+	// Assert that contents matches a snapshot.
+	snapshot(contents: any, message?: string): void;
 	// Assert that contents does not match regex.
 	notRegex(contents: string, regex: RegExp, message?: string): void;
 	// Assert that error is falsy.

package/lib/cli.js

@@ -24,7 +24,7 @@ exports.run = () => {
 	const conf = pkgConf.sync('ava');
 
 	const filepath = pkgConf.filepath(conf);
-	const pkgDir = filepath === null ? process.cwd() : path.dirname(filepath);
+	const projectDir = filepath === null ? process.cwd() : path.dirname(filepath);
 
 	const cli = meow(`
 		Usage
@@ -38,6 +38,7 @@ exports.run = () => {
 		  --verbose, -v           Enable verbose output
 		  --no-cache              Disable the transpiler cache
 		  --no-power-assert       Disable Power Assert
+		  --no-color              Disable color output
 		  --match, -m             Only run tests with matching title (Can be repeated)
 		  --watch, -w             Re-run tests when tests and source files change
 		  --timeout, -T           Set global timeout
@@ -68,9 +69,10 @@ exports.run = () => {
 			'tap',
 			'verbose',
 			'watch',
-			'update-snapshots'
+			'update-snapshots',
+			'color'
 		],
-		default: conf,
+		default: Object.assign({color: true}, conf),
 		alias: {
 			t: 'tap',
 			v: 'verbose',
@@ -114,11 +116,12 @@ exports.run = () => {
 		explicitTitles: cli.flags.watch,
 		match: arrify(cli.flags.match),
 		babelConfig: babelConfig.validate(conf.babel),
-		resolveTestsFrom: cli.input.length === 0 ? pkgDir : process.cwd(),
-		pkgDir,
+		resolveTestsFrom: cli.input.length === 0 ? projectDir : process.cwd(),
+		projectDir,
 		timeout: cli.flags.timeout,
 		concurrency: cli.flags.concurrency ? parseInt(cli.flags.concurrency, 10) : 0,
-		updateSnapshots: cli.flags.updateSnapshots
+		updateSnapshots: cli.flags.updateSnapshots,
+		color: cli.flags.color
 	});
 
 	let reporter;
@@ -126,9 +129,9 @@ exports.run = () => {
 	if (cli.flags.tap && !cli.flags.watch) {
 		reporter = new TapReporter();
 	} else if (cli.flags.verbose || isCi) {
-		reporter = new VerboseReporter({basePath: pkgDir});
+		reporter = new VerboseReporter({color: cli.flags.color});
 	} else {
-		reporter = new MiniReporter({watching: cli.flags.watch, basePath: pkgDir});
+		reporter = new MiniReporter({color: cli.flags.color, watching: cli.flags.watch});
 	}
 
 	reporter.api = api;

package/lib/code-excerpt.js

@@ -8,12 +8,25 @@ const chalk = require('chalk');
 const formatLineNumber = (lineNumber, maxLineNumber) =>
 	' '.repeat(Math.max(0, String(maxLineNumber).length - String(lineNumber).length)) + lineNumber;
 
-module.exports = (file, line, options) => {
-	options = options || {};
+module.exports = (source, options) => {
+	if (!source.isWithinProject || source.isDependency) {
+		return null;
+	}
 
+	const file = source.file;
+	const line = source.line;
+
+	options = options || {};
 	const maxWidth = options.maxWidth || 80;
-	const source = fs.readFileSync(file, 'utf8');
-	const excerpt = codeExcerpt(source, line, {around: 1});
+
+	let contents;
+	try {
+		contents = fs.readFileSync(file, 'utf8');
+	} catch (err) {
+		return null;
+	}
+
+	const excerpt = codeExcerpt(contents, line, {around: 1});
 	if (!excerpt) {
 		return null;
 	}

package/lib/fork.js

@@ -36,8 +36,10 @@ module.exports = (file, opts, execArgv) => {
 		} : false
 	}, opts);
 
-	const ps = childProcess.fork(path.join(__dirname, 'test-worker.js'), [JSON.stringify(opts)], {
-		cwd: opts.pkgDir,
+	const args = [JSON.stringify(opts), opts.color ? '--color' : '--no-color'];
+
+	const ps = childProcess.fork(path.join(__dirname, 'test-worker.js'), args, {
+		cwd: opts.projectDir,
 		silent: true,
 		env,
 		execArgv: execArgv || process.execArgv

package/lib/main.js

@@ -70,7 +70,11 @@ globals.setImmediate(() => {
 	runner.on('test', test);
 
 	process.on('ava-run', options => {
-		runner.run(options).then(exit);
+		runner.run(options)
+			.then(exit)
+			.catch(err => {
+				process.emit('uncaughtException', err);
+			});
 	});
 
 	process.on('ava-init-exit', () => {

package/lib/reporters/mini.js

@@ -1,6 +1,5 @@
 'use strict';
 const StringDecoder = require('string_decoder').StringDecoder;
-const path = require('path');
 const cliCursor = require('cli-cursor');
 const lastLineTracker = require('last-line-stream/tracker');
 const plur = require('plur');
@@ -14,11 +13,6 @@ const extractStack = require('../extract-stack');
 const codeExcerpt = require('../code-excerpt');
 const colors = require('../colors');
 
-chalk.enabled = true;
-Object.keys(colors).forEach(key => {
-	colors[key].enabled = true;
-});
-
 // TODO(@jamestalamge): This should be fixed in log-update and ansi-escapes once we are confident it's a good solution.
 const CSI = '\u001b[';
 const ERASE_LINE = CSI + '2K';
@@ -42,12 +36,17 @@ function eraseLines(count) {
 
 class MiniReporter {
 	constructor(options) {
+		this.options = Object.assign({}, options);
+
+		chalk.enabled = this.options.color;
+		for (const key of Object.keys(colors)) {
+			colors[key].enabled = this.options.color;
+		}
+
 		const spinnerDef = spinners[process.platform === 'win32' ? 'line' : 'dots'];
 		this.spinnerFrames = spinnerDef.frames.map(c => chalk.gray.dim(c));
 		this.spinnerInterval = spinnerDef.interval;
 
-		this.options = Object.assign({}, options);
-
 		this.reset();
 		this.stream = process.stderr;
 		this.stringDecoder = new StringDecoder();
@@ -187,8 +186,7 @@ class MiniReporter {
 				if (test.error.source) {
 					status += '  ' + colors.errorSource(test.error.source.file + ':' + test.error.source.line) + '\n';
 
-					const errorPath = path.join(this.options.basePath, test.error.source.file);
-					const excerpt = codeExcerpt(errorPath, test.error.source.line, {maxWidth: process.stdout.columns});
+					const excerpt = codeExcerpt(test.error.source, {maxWidth: process.stdout.columns});
 					if (excerpt) {
 						status += '\n' + indentString(excerpt, 2) + '\n';
 					}
@@ -204,7 +202,10 @@ class MiniReporter {
 				}
 
 				if (test.error.stack) {
-					status += '\n' + indentString(colors.errorStack(extractStack(test.error.stack)), 2);
+					const extracted = extractStack(test.error.stack);
+					if (extracted.includes('\n')) {
+						status += '\n' + indentString(colors.errorStack(extracted), 2);
+					}
 				}
 			});
 		}
@@ -233,7 +234,8 @@ class MiniReporter {
 		}
 
 		if (runStatus.failFastEnabled === true && runStatus.remainingCount > 0 && runStatus.failCount > 0) {
-			status += '\n\n  ' + colors.information('`--fail-fast` is on. Any number of tests may have been skipped');
+			const remaining = 'At least ' + runStatus.remainingCount + ' ' + plur('test was', 'tests were', runStatus.remainingCount) + ' skipped.';
+			status += '\n\n  ' + colors.information('`--fail-fast` is on. ' + remaining);
 		}
 
 		if (runStatus.hasExclusive === true && runStatus.remainingCount > 0) {

package/lib/reporters/verbose.js

@@ -1,5 +1,4 @@
 'use strict';
-const path = require('path');
 const indentString = require('indent-string');
 const prettyMs = require('pretty-ms');
 const figures = require('figures');
@@ -10,13 +9,14 @@ const extractStack = require('../extract-stack');
 const codeExcerpt = require('../code-excerpt');
 const colors = require('../colors');
 
-Object.keys(colors).forEach(key => {
-	colors[key].enabled = true;
-});
-
 class VerboseReporter {
 	constructor(options) {
 		this.options = Object.assign({}, options);
+
+		chalk.enabled = this.options.color;
+		for (const key of Object.keys(colors)) {
+			colors[key].enabled = this.options.color;
+		}
 	}
 	start() {
 		return '';
@@ -105,8 +105,7 @@ class VerboseReporter {
 				if (test.error.source) {
 					output += '  ' + colors.errorSource(test.error.source.file + ':' + test.error.source.line) + '\n';
 
-					const errorPath = path.join(this.options.basePath, test.error.source.file);
-					const excerpt = codeExcerpt(errorPath, test.error.source.line, {maxWidth: process.stdout.columns});
+					const excerpt = codeExcerpt(test.error.source, {maxWidth: process.stdout.columns});
 					if (excerpt) {
 						output += '\n' + indentString(excerpt, 2) + '\n';
 					}
@@ -122,13 +121,17 @@ class VerboseReporter {
 				}
 
 				if (test.error.stack) {
-					output += '\n' + indentString(colors.errorStack(extractStack(test.error.stack)), 2);
+					const extracted = extractStack(test.error.stack);
+					if (extracted.includes('\n')) {
+						output += '\n' + indentString(colors.errorStack(extracted), 2);
+					}
 				}
 			});
 		}
 
 		if (runStatus.failFastEnabled === true && runStatus.remainingCount > 0 && runStatus.failCount > 0) {
-			output += '\n\n\n  ' + colors.information('`--fail-fast` is on. Any number of tests may have been skipped');
+			const remaining = 'At least ' + runStatus.remainingCount + ' ' + plur('test was', 'tests were', runStatus.remainingCount) + ' skipped.';
+			output += '\n\n\n  ' + colors.information('`--fail-fast` is on. ' + remaining);
 		}
 
 		if (runStatus.hasExclusive === true && runStatus.remainingCount > 0) {

package/lib/serialize-error.js

@@ -1,4 +1,5 @@
 'use strict';
+const path = require('path');
 const cleanYamlObject = require('clean-yaml-object');
 const StackUtils = require('stack-utils');
 const prettyFormat = require('@ava/pretty-format');
@@ -8,6 +9,7 @@ const extractStack = require('./extract-stack');
 
 function serializeValue(value) {
 	return prettyFormat(value, {
+		callToJSON: false,
 		plugins: [reactTestPlugin],
 		highlight: true
 	});
@@ -58,8 +60,21 @@ module.exports = error => {
 		const firstStackLine = extractStack(err.stack).split('\n')[0];
 		const source = stackUtils.parseLine(firstStackLine);
 		if (source) {
+			// Assume the CWD is the project directory. This holds since this function
+			// is only called in test workers, which are created with their working
+			// directory set to the project directory.
+			const projectDir = process.cwd();
+
+			const file = path.resolve(projectDir, source.file.trim());
+			const rel = path.relative(projectDir, file);
+
+			const isWithinProject = rel.split(path.sep)[0] !== '..';
+			const isDependency = isWithinProject && path.dirname(rel).split(path.sep).indexOf('node_modules') > -1;
+
 			err.source = {
-				file: source.file.trim(),
+				isDependency,
+				isWithinProject,
+				file,
 				line: source.line
 			};
 		}

package/lib/test-worker.js

@@ -36,7 +36,20 @@ process.on('unhandledRejection', throwsHelper);
 
 process.on('uncaughtException', exception => {
 	throwsHelper(exception);
-	send('uncaughtException', {exception: serializeError(exception)});
+
+	let serialized;
+	try {
+		serialized = serializeError(exception);
+	} catch (ignore) { // eslint-disable-line unicorn/catch-error-name
+		// Avoid using serializeError
+		const err = new Error('Failed to serialize uncaught exception');
+		serialized = {
+			name: err.name,
+			message: err.message,
+			stack: err.stack
+		};
+	}
+	send('uncaughtException', {exception: serialized});
 });
 
 // If AVA was not required, show an error

package/lib/test.js

@@ -240,10 +240,9 @@ class Test {
 				this._setAssertError(new Error(`Do not return ${asyncType} from tests declared via \`test.cb(...)\`, if you want to return a promise simply declare the test via \`test(...)\``));
 			}
 
-			ret.then(
-				() => {
-					this.exit();
-				},
+			// Convert to a Bluebird promise
+			return Promise.resolve(ret).then(
+				() => this.exit(),
 				err => {
 					if (!(err instanceof Error)) {
 						err = new assert.AssertionError({
@@ -254,10 +253,9 @@ class Test {
 					}
 
 					this._setAssertError(err);
-					this.exit();
-				});
-
-			return this.promise().promise;
+					return this.exit();
+				}
+			);
 		}
 
 		if (this.metadata.callback && !this.threwSync) {

package/lib/watcher.js

@@ -107,13 +107,15 @@ class Watcher {
 				}
 			}
 
-			this.busy = api.run(specificFiles || files, {runOnlyExclusive}).then(runStatus => {
-				runStatus.previousFailCount = this.sumPreviousFailures(currentVector);
-				logger.finish(runStatus);
-
-				const badCounts = runStatus.failCount + runStatus.rejectionCount + runStatus.exceptionCount;
-				this.clearLogOnNextRun = this.clearLogOnNextRun && badCounts === 0;
-			}, rethrowAsync);
+			this.busy = api.run(specificFiles || files, {runOnlyExclusive})
+				.then(runStatus => {
+					runStatus.previousFailCount = this.sumPreviousFailures(currentVector);
+					logger.finish(runStatus);
+
+					const badCounts = runStatus.failCount + runStatus.rejectionCount + runStatus.exceptionCount;
+					this.clearLogOnNextRun = this.clearLogOnNextRun && badCounts === 0;
+				})
+				.catch(rethrowAsync);
 		};
 
 		this.testDependencies = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ava",
-  "version": "0.18.1",
+  "version": "0.18.2",
   "description": "Futuristic test runner 🚀",
   "license": "MIT",
   "repository": "avajs/ava",
@@ -43,7 +43,7 @@
     "node": ">=4"
   },
   "scripts": {
-    "test": "xo && nyc tap --no-cov --timeout=150 --jobs=4 test/*.js test/reporters/*.js",
+    "test": "xo && flow check test/flow-types && nyc tap --no-cov --timeout=150 --jobs=4 test/*.js test/reporters/*.js",
     "test-win": "tap --no-cov --reporter=classic --timeout=150 --jobs=4 test/*.js test/reporters/*.js",
     "visual": "node test/visual/run-visual-tests.js",
     "prepublish": "npm run make-ts",
@@ -89,7 +89,7 @@
   "dependencies": {
     "@ava/babel-preset-stage-4": "^1.0.0",
     "@ava/babel-preset-transform-test-files": "^2.0.0",
-    "@ava/pretty-format": "^1.0.0",
+    "@ava/pretty-format": "^1.1.0",
     "arr-flatten": "^1.0.1",
     "array-union": "^1.0.1",
     "array-uniq": "^1.0.2",
@@ -154,7 +154,7 @@
     "resolve-cwd": "^1.0.0",
     "slash": "^1.0.0",
     "source-map-support": "^0.4.0",
-    "stack-utils": "^0.4.0",
+    "stack-utils": "^1.0.0",
     "strip-ansi": "^3.0.1",
     "strip-bom-buf": "^1.0.0",
     "time-require": "^0.1.2",
@@ -167,6 +167,7 @@
     "coveralls": "^2.11.4",
     "delay": "^1.3.0",
     "execa": "^0.6.0",
+    "flow-bin": "^0.38.0",
     "get-stream": "^3.0.0",
     "git-branch": "^0.3.0",
     "has-ansi": "^2.0.0",
@@ -182,7 +183,7 @@
     "sinon": "^1.17.2",
     "source-map-fixtures": "^2.1.0",
     "tap": "^10.0.0",
-    "temp-write": "^3.0.0",
+    "temp-write": "^3.1.0",
     "touch": "^1.0.0",
     "xo": "^0.17.0",
     "zen-observable": "^0.4.0"
@@ -196,6 +197,7 @@
   },
   "nyc": {
     "reporter": [
+      "html",
       "lcov",
       "text"
     ]

package/readme.md

@@ -42,6 +42,7 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/rea
 - Runs tests concurrently
 - Enforces writing atomic tests
 - No implicit globals
+- Includes TypeScript & Flow type definitions
 - [Magic assert](#magic-assert)
 - [Isolated environment for each test file](#process-isolation)
 - [Write your tests in ES2017](#es2017-support)
@@ -163,6 +164,7 @@ $ ava --help
     --verbose, -v           Enable verbose output
     --no-cache              Disable the transpiler cache
     --no-power-assert       Disable Power Assert
+    --no-color              Disable color output
     --match, -m             Only run tests with matching title (Can be repeated)
     --watch, -w             Re-run tests when tests and source files change
     --timeout, -T           Set global timeout
@@ -912,11 +914,15 @@ Assert that `value` is not equal to `expected`.
 
 ### `.deepEqual(value, expected, [message])`
 
-Assert that `value` is deep equal to `expected`.
+Assert that `value` is deep equal to `expected`. This is based on [Lodash' `isEqual()`](https://lodash.com/docs/4.17.4#isEqual):
+
+> Performs a deep comparison between two values to determine if they are equivalent.
+>
+> *Note*: This method supports comparing arrays, array buffers, booleans, date objects, error objects, maps, numbers, `Object` objects, regexes, sets, strings, symbols, and typed arrays. `Object` objects are compared by their own, not inherited, enumerable properties. Functions and DOM nodes are compared by strict equality, i.e. `===`.
 
 ### `.notDeepEqual(value, expected, [message])`
 
-Assert that `value` is not deep equal to `expected`.
+Assert that `value` is not deep equal to `expected`. The inverse of `.deepEqual()`.
 
 ### `.throws(function|promise, [error, [message]])`
 

package/types/generated.d.ts

@@ -71,6 +71,10 @@ export interface AssertContext {
 	 * Assert that contents matches regex.
 	 */
 	regex(contents: string, regex: RegExp, message?: string): void;
+	/**
+	 * Assert that contents matches a snapshot.
+	 */
+	snapshot(contents: any, message?: string): void;
 	/**
 	 * Assert that contents does not match regex.
 	 */