ava 0.16.0 → 0.18.2

package/lib/reporters/tap.js

@@ -1,8 +1,8 @@
 'use strict';
-var format = require('util').format;
-var stripAnsi = require('strip-ansi');
+const format = require('util').format;
+const stripAnsi = require('strip-ansi');
 
-// Parses stack trace and extracts original function name, file name and line.
+// Parses stack trace and extracts original function name, file name and line
 function getSourceFromStack(stack, index) {
 	return stack
 		.split('\n')
@@ -11,94 +11,89 @@ function getSourceFromStack(stack, index) {
 		.replace(/^\s+ /, '');
 }
 
-function TapReporter() {
-	if (!(this instanceof TapReporter)) {
-		return new TapReporter();
+class TapReporter {
+	constructor() {
+		this.i = 0;
 	}
-
-	this.i = 0;
-}
-
-module.exports = TapReporter;
-
-TapReporter.prototype.start = function () {
-	return 'TAP version 13';
-};
-
-TapReporter.prototype.test = function (test) {
-	var output;
-
-	var directive = '';
-	var passed = test.todo ? 'not ok' : 'ok';
-
-	if (test.todo) {
-		directive = '# TODO';
-	} else if (test.skip) {
-		directive = '# SKIP';
+	start() {
+		return 'TAP version 13';
 	}
-
-	var title = stripAnsi(test.title);
-
-	if (test.error) {
-		output = [
-			'# ' + title,
-			format('not ok %d - %s', ++this.i, title),
-			'  ---',
-			'    operator: ' + test.error.operator,
-			'    expected: ' + test.error.expected,
-			'    actual: ' + test.error.actual,
-			'    at: ' + getSourceFromStack(test.error.stack, 1),
-			'  ...'
-		];
-	} else {
-		output = [
-			'# ' + title,
-			format('%s %d - %s %s', passed, ++this.i, title, directive).trim()
-		];
+	test(test) {
+		let 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);
+
+		if (test.error) {
+			output = [
+				'# ' + title,
+				format('not ok %d - %s', ++this.i, title),
+				'  ---',
+				'    operator: ' + test.error.operator,
+				'    expected: ' + test.error.expected,
+				'    actual: ' + test.error.actual,
+				'    at: ' + getSourceFromStack(test.error.stack, 1),
+				'  ...'
+			];
+		} else {
+			output = [
+				`# ${title}`,
+				format('%s %d - %s %s', passed, ++this.i, title, directive).trim()
+			];
+		}
+
+		return output.join('\n');
 	}
-
-	return output.join('\n');
-};
-
-TapReporter.prototype.unhandledError = function (err) {
-	var output = [
-		'# ' + err.message,
-		format('not ok %d - %s', ++this.i, err.message)
-	];
-	// AvaErrors don't have stack traces.
-	if (err.type !== 'exception' || err.name !== 'AvaError') {
-		output.push(
-			'  ---',
-			'    name: ' + err.name,
-			'    at: ' + getSourceFromStack(err.stack, 1),
-			'  ...'
-		);
+	unhandledError(err) {
+		const output = [
+			`# ${err.message}`,
+			format('not ok %d - %s', ++this.i, err.message)
+		];
+		// AvaErrors don't have stack traces
+		if (err.type !== 'exception' || err.name !== 'AvaError') {
+			output.push(
+				'  ---',
+				'    name: ' + err.name,
+				'    at: ' + getSourceFromStack(err.stack, 1),
+				'  ...'
+			);
+		}
+
+		return output.join('\n');
 	}
+	finish(runStatus) {
+		const output = [
+			'',
+			'1..' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
+			'# tests ' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
+			'# pass ' + runStatus.passCount
+		];
 
-	return output.join('\n');
-};
+		if (runStatus.skipCount > 0) {
+			output.push(`# skip ${runStatus.skipCount}`);
+		}
 
-TapReporter.prototype.finish = function (runStatus) {
-	var output = [
-		'',
-		'1..' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
-		'# tests ' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
-		'# pass ' + runStatus.passCount
-	];
+		output.push('# fail ' + (runStatus.failCount + runStatus.rejectionCount + runStatus.exceptionCount), '');
 
-	if (runStatus.skipCount > 0) {
-		output.push('# skip ' + runStatus.skipCount);
+		return output.join('\n');
 	}
+	write(str) {
+		console.log(str);
+	}
+	stdout(data) {
+		process.stderr.write(data);
+	}
+	stderr(data) {
+		this.stdout(data);
+	}
+}
 
-	output.push('# fail ' + (runStatus.failCount + runStatus.rejectionCount + runStatus.exceptionCount), '');
-
-	return output.join('\n');
-};
-
-TapReporter.prototype.write = function (str) {
-	console.log(str);
-};
-
-TapReporter.prototype.stdout = TapReporter.prototype.stderr = function (data) {
-	process.stderr.write(data);
-};
+module.exports = TapReporter;

package/lib/reporters/verbose.js

@@ -1,130 +1,157 @@
 'use strict';
-var prettyMs = require('pretty-ms');
-var figures = require('figures');
-var chalk = require('chalk');
-var plur = require('plur');
-var repeating = require('repeating');
-var colors = require('../colors');
-
-Object.keys(colors).forEach(function (key) {
-	colors[key].enabled = true;
-});
-
-function VerboseReporter() {
-	if (!(this instanceof VerboseReporter)) {
-		return new VerboseReporter();
+const indentString = require('indent-string');
+const prettyMs = require('pretty-ms');
+const figures = require('figures');
+const chalk = require('chalk');
+const plur = require('plur');
+const formatAssertError = require('../format-assert-error');
+const extractStack = require('../extract-stack');
+const codeExcerpt = require('../code-excerpt');
+const colors = require('../colors');
+
+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;
+		}
 	}
-}
-
-module.exports = VerboseReporter;
-
-VerboseReporter.prototype.start = function () {
-	return '';
-};
-
-VerboseReporter.prototype.test = function (test, runStatus) {
-	if (test.error) {
-		return '  ' + colors.error(figures.cross) + ' ' + test.title + ' ' + colors.error(test.error.message);
+	start() {
+		return '';
 	}
-
-	if (test.todo) {
-		return '  ' + colors.todo('- ' + test.title);
-	} else if (test.skip) {
-		return '  ' + colors.skip('- ' + test.title);
+	test(test, runStatus) {
+		if (test.error) {
+			return '  ' + colors.error(figures.cross) + ' ' + test.title + ' ' + colors.error(test.error.message);
+		}
+
+		if (test.todo) {
+			return '  ' + colors.todo('- ' + test.title);
+		} else if (test.skip) {
+			return '  ' + colors.skip('- ' + test.title);
+		}
+
+		if (test.failing) {
+			return '  ' + colors.error(figures.tick) + ' ' + colors.error(test.title);
+		}
+
+		if (runStatus.fileCount === 1 && runStatus.testCount === 1 && test.title === '[anonymous]') {
+			return undefined;
+		}
+
+		// Display duration only over a threshold
+		const threshold = 100;
+		const duration = test.duration > threshold ? colors.duration(' (' + prettyMs(test.duration) + ')') : '';
+
+		return '  ' + colors.pass(figures.tick) + ' ' + test.title + duration;
 	}
+	unhandledError(err) {
+		if (err.type === 'exception' && err.name === 'AvaError') {
+			return colors.error('  ' + figures.cross + ' ' + err.message);
+		}
 
-	if (test.failing) {
-		return '  ' + colors.error(figures.tick) + ' ' + colors.error(test.title);
-	}
+		const types = {
+			rejection: 'Unhandled Rejection',
+			exception: 'Uncaught Exception'
+		};
 
-	if (runStatus.fileCount === 1 && runStatus.testCount === 1 && test.title === '[anonymous]') {
-		return undefined;
-	}
+		let output = colors.error(types[err.type] + ':', err.file) + '\n';
 
-	// display duration only over a threshold
-	var threshold = 100;
-	var duration = test.duration > threshold ? colors.duration(' (' + prettyMs(test.duration) + ')') : '';
+		if (err.stack) {
+			output += '  ' + colors.stack(err.stack) + '\n';
+		} else {
+			output += '  ' + colors.stack(JSON.stringify(err)) + '\n';
+		}
 
-	return '  ' + colors.pass(figures.tick) + ' ' + test.title + duration;
-};
+		output += '\n';
 
-VerboseReporter.prototype.unhandledError = function (err) {
-	if (err.type === 'exception' && err.name === 'AvaError') {
-		return colors.error('  ' + figures.cross + ' ' + err.message);
+		return output;
 	}
-
-	var types = {
-		rejection: 'Unhandled Rejection',
-		exception: 'Uncaught Exception'
-	};
-
-	var output = colors.error(types[err.type] + ':', err.file) + '\n';
-
-	if (err.stack) {
-		output += '  ' + colors.stack(err.stack) + '\n';
-	} else {
-		output += '  ' + colors.stack(JSON.stringify(err)) + '\n';
+	finish(runStatus) {
+		let output = '\n';
+
+		const lines = [
+			runStatus.failCount > 0 ?
+				'  ' + colors.error(runStatus.failCount, plur('test', runStatus.failCount), 'failed') :
+				'  ' + colors.pass(runStatus.passCount, plur('test', runStatus.passCount), 'passed'),
+			runStatus.knownFailureCount > 0 ? '  ' + colors.error(runStatus.knownFailureCount, plur('known failure', runStatus.knownFailureCount)) : '',
+			runStatus.skipCount > 0 ? '  ' + colors.skip(runStatus.skipCount, plur('test', runStatus.skipCount), 'skipped') : '',
+			runStatus.todoCount > 0 ? '  ' + colors.todo(runStatus.todoCount, plur('test', runStatus.todoCount), 'todo') : '',
+			runStatus.rejectionCount > 0 ? '  ' + colors.error(runStatus.rejectionCount, 'unhandled', plur('rejection', runStatus.rejectionCount)) : '',
+			runStatus.exceptionCount > 0 ? '  ' + colors.error(runStatus.exceptionCount, 'uncaught', plur('exception', runStatus.exceptionCount)) : '',
+			runStatus.previousFailCount > 0 ? '  ' + colors.error(runStatus.previousFailCount, 'previous', plur('failure', runStatus.previousFailCount), 'in test files that were not rerun') : ''
+		].filter(Boolean);
+
+		if (lines.length > 0) {
+			lines[0] += ' ' + chalk.gray.dim('[' + new Date().toLocaleTimeString('en-US', {hour12: false}) + ']');
+			output += lines.join('\n');
+		}
+
+		if (runStatus.knownFailureCount > 0) {
+			runStatus.knownFailures.forEach(test => {
+				output += '\n\n\n  ' + colors.error(test.title);
+			});
+		}
+
+		if (runStatus.failCount > 0) {
+			runStatus.tests.forEach((test, index) => {
+				if (!test.error) {
+					return;
+				}
+
+				const beforeSpacing = index === 0 ? '\n\n' : '\n\n\n\n';
+				output += beforeSpacing + '  ' + colors.title(test.title) + '\n';
+				if (test.error.source) {
+					output += '  ' + colors.errorSource(test.error.source.file + ':' + test.error.source.line) + '\n';
+
+					const excerpt = codeExcerpt(test.error.source, {maxWidth: process.stdout.columns});
+					if (excerpt) {
+						output += '\n' + indentString(excerpt, 2) + '\n';
+					}
+				}
+
+				if (test.error.showOutput) {
+					output += '\n' + indentString(formatAssertError(test.error), 2);
+				}
+
+				// `.trim()` is needed, because default `err.message` is ' ' (see lib/assert.js)
+				if (test.error.message.trim()) {
+					output += '\n' + indentString(test.error.message, 2) + '\n';
+				}
+
+				if (test.error.stack) {
+					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) {
+			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) {
+			output += '\n\n\n  ' + colors.information('The .only() modifier is used in some tests.', runStatus.remainingCount, plur('test', runStatus.remainingCount), plur('was', 'were', runStatus.remainingCount), 'not run');
+		}
+
+		return output + '\n';
 	}
-
-	output += '\n';
-
-	return output;
-};
-
-VerboseReporter.prototype.finish = function (runStatus) {
-	var output = '\n';
-
-	var lines = [
-		runStatus.failCount > 0 ?
-			'  ' + colors.error(runStatus.failCount, plur('test', runStatus.failCount), 'failed') :
-			'  ' + colors.pass(runStatus.passCount, plur('test', runStatus.passCount), 'passed'),
-		runStatus.knownFailureCount > 0 ? '  ' + colors.error(runStatus.knownFailureCount, plur('known failure', runStatus.knownFailureCount)) : '',
-		runStatus.skipCount > 0 ? '  ' + colors.skip(runStatus.skipCount, plur('test', runStatus.skipCount), 'skipped') : '',
-		runStatus.todoCount > 0 ? '  ' + colors.todo(runStatus.todoCount, plur('test', runStatus.todoCount), 'todo') : '',
-		runStatus.rejectionCount > 0 ? '  ' + colors.error(runStatus.rejectionCount, 'unhandled', plur('rejection', runStatus.rejectionCount)) : '',
-		runStatus.exceptionCount > 0 ? '  ' + colors.error(runStatus.exceptionCount, 'uncaught', plur('exception', runStatus.exceptionCount)) : '',
-		runStatus.previousFailCount > 0 ? '  ' + colors.error(runStatus.previousFailCount, 'previous', plur('failure', runStatus.previousFailCount), 'in test files that were not rerun') : ''
-	].filter(Boolean);
-
-	if (lines.length > 0) {
-		lines[0] += ' ' + chalk.gray.dim('[' + new Date().toLocaleTimeString('en-US', {hour12: false}) + ']');
-		output += lines.join('\n');
+	section() {
+		return chalk.gray.dim('\u2500'.repeat(process.stdout.columns || 80));
 	}
-
-	var i = 0;
-
-	if (runStatus.knownFailureCount > 0) {
-		runStatus.knownFailures.forEach(function (test) {
-			i++;
-			output += '\n\n\n  ' + colors.error(i + '.', test.title);
-		});
+	write(str) {
+		console.error(str);
 	}
-
-	if (runStatus.failCount > 0) {
-		runStatus.tests.forEach(function (test) {
-			if (!(test.error && test.error.message)) {
-				return;
-			}
-
-			i++;
-
-			output += '\n\n\n  ' + colors.error(i + '.', test.title) + '\n';
-			var stack = test.error.stack ? test.error.stack.trimRight() : '';
-			output += '  ' + colors.stack(stack);
-		});
+	stdout(data) {
+		process.stderr.write(data);
 	}
+	stderr(data) {
+		process.stderr.write(data);
+	}
+}
 
-	return output + '\n';
-};
-
-VerboseReporter.prototype.section = function () {
-	return chalk.gray.dim(repeating('\u2500', process.stdout.columns || 80));
-};
-
-VerboseReporter.prototype.write = function (str) {
-	console.error(str);
-};
-
-VerboseReporter.prototype.stdout = VerboseReporter.prototype.stderr = function (data) {
-	process.stderr.write(data);
-};
+module.exports = VerboseReporter;