Disable TAP reporter in watch mode (#732)

* disable tap reporter in watch mode

Fixes #672

* write missing chokidar error to stderr

Author: novemberborn

cli.js

@@ -25,6 +25,7 @@ var Promise = require('bluebird');
 var pkgConf = require('pkg-conf');
 var chalk = require('chalk');
 var isCi = require('is-ci');
+var hasFlag = require('has-flag');
 var colors = require('./lib/colors');
 var verboseReporter = require('./lib/reporters/verbose');
 var miniReporter = require('./lib/reporters/mini');
@@ -116,6 +117,14 @@ if (cli.flags.init) {
 	return;
 }
 
+if (
+	(hasFlag('--watch') || hasFlag('-w')) && (hasFlag('--tap') || hasFlag('-t')) ||
+	conf.watch && conf.tap
+) {
+	console.error('  ' + colors.error(figures.cross) + ' The TAP reporter is not available when using watch mode.');
+	process.exit(1);
+}
+
 var api = new Api({
 	failFast: cli.flags.failFast,
 	serial: cli.flags.serial,
@@ -129,7 +138,7 @@ var api = new Api({
 
 var reporter;
 
-if (cli.flags.tap) {
+if (cli.flags.tap && !cli.flags.watch) {
 	reporter = tapReporter();
 } else if (cli.flags.verbose || isCi) {
 	reporter = verboseReporter();
@@ -167,7 +176,7 @@ if (cli.flags.watch) {
 	} catch (err) {
 		if (err.name === 'AvaError') {
 			// An AvaError may be thrown if chokidar is not installed. Log it nicely.
-			console.log('  ' + colors.error(figures.cross) + ' ' + err.message);
+			console.error('  ' + colors.error(figures.cross) + ' ' + err.message);
 			logger.exit(1);
 		} else {
 			// Rethrow so it becomes an uncaught exception.

docs/recipes/watch-mode.md

@@ -45,6 +45,8 @@ And then use:
 $ npm run test:watch
 ```
 
+Please note that the TAP reporter is unavailable when using watch mode.
+
 ## Requirements
 
 AVA uses [`chokidar`] as the file watcher. It's configured as an optional dependency since `chokidar` sometimes can't be installed. Watch mode is not available if `chokidar` fails to install, instead you'll see a message like:

package.json

@@ -104,6 +104,7 @@
     "find-cache-dir": "^0.1.1",
     "fn-name": "^2.0.0",
     "globby": "^4.0.0",
+    "has-flag": "^2.0.0",
     "ignore-by-default": "^1.0.0",
     "is-ci": "^1.0.7",
     "is-generator-fn": "^1.0.0",

readme.md

@@ -676,6 +676,8 @@ $ ava --tap | tap-nyan
 
 <img src="media/tap-output.png" width="398">
 
+Please note that the TAP reporter is unavailable when using [watch mode](#watch-it).
+
 ### Clean stack traces
 
 AVA automatically removes unrelated lines in stack traces, allowing you to find the source of an error much faster.

test/cli.js

@@ -14,6 +14,12 @@ var cliPath = path.join(__dirname, '../cli.js');
 chalk.enabled = true;
 var colors = require('../lib/colors');
 
+var hasChokidar = false;
+try {
+	require('chokidar');
+	hasChokidar = true;
+} catch (err) {}
+
 function execCli(args, opts, cb) {
 	var dirname;
 	var env;
@@ -173,16 +179,10 @@ test('pkg-conf: cli takes precedence', function (t) {
 test('watcher works', function (t) {
 	var killed = false;
 
-	var hasChokidar = false;
-	try {
-		require('chokidar');
-		hasChokidar = true;
-	} catch (err) {}
-
-	var child = execCli(['--verbose', '--watch', 'test.js'], {dirname: 'fixture/watcher'}, function (err, stdout) {
+	var child = execCli(['--verbose', '--watch', 'test.js'], {dirname: 'fixture/watcher'}, function (err, stdout, stderr) {
 		if (err && err.code === 1 && !hasChokidar) {
 			t.comment('chokidar dependency is missing, cannot test watcher');
-			t.match(stdout, 'The optional dependency chokidar failed to install and is required for --watch. Chokidar is likely not supported on your platform.');
+			t.match(stderr, 'The optional dependency chokidar failed to install and is required for --watch. Chokidar is likely not supported on your platform.');
 			t.end();
 		} else {
 			t.ok(killed);
@@ -208,6 +208,49 @@ test('watcher works', function (t) {
 	});
 });
 
+if (hasChokidar) {
+	test('`"tap": true` config is ignored when --watch is given', function (t) {
+		var killed = false;
+
+		var child = execCli(['--watch', 'test.js'], {dirname: 'fixture/watcher/tap-in-conf'}, function () {
+			t.ok(killed);
+			t.end();
+		});
+
+		var combined = '';
+		var testOutput = function (output) {
+			combined += output;
+			t.notMatch(combined, /TAP/);
+			if (/works/.test(combined)) {
+				child.kill();
+				killed = true;
+			}
+		};
+		child.stdout.on('data', testOutput);
+		child.stderr.on('data', testOutput);
+	});
+
+	test('bails when config contains `"tap": true` and `"watch": true`', function (t) {
+		execCli(['test.js'], {dirname: 'fixture/watcher/tap-and-watch-in-conf'}, function (err, stdout, stderr) {
+			t.is(err.code, 1);
+			t.match(stderr, 'The TAP reporter is not available when using watch mode.');
+			t.end();
+		}).stderr.pipe(process.stderr);
+	});
+
+	['--watch', '-w'].forEach(function (watchFlag) {
+		['--tap', '-t'].forEach(function (tapFlag) {
+			test('bails when ' + tapFlag + ' reporter is used while ' + watchFlag + ' is given', function (t) {
+				execCli([tapFlag, watchFlag, 'test.js'], {dirname: 'fixture/watcher'}, function (err, stdout, stderr) {
+					t.is(err.code, 1);
+					t.match(stderr, 'The TAP reporter is not available when using watch mode.');
+					t.end();
+				}).stderr.pipe(process.stderr);
+			});
+		});
+	});
+}
+
 test('--match works', function (t) {
 	execCli(['-m=foo', '-m=bar', '-m=!baz', '-m=t* a* f*', '-m=!t* a* n* f*', 'fixture/matcher-skip.js'], function (err) {
 		t.ifError(err);

test/fixture/watcher/tap-and-watch-in-conf/package.json

@@ -0,0 +1,6 @@
+{
+  "ava": {
+    "tap": true,
+    "watch": true
+  }
+}

test/fixture/watcher/tap-and-watch-in-conf/test.js

@@ -0,0 +1,5 @@
+import test from '../../../../';
+
+test('works', t => {
+	t.pass();
+});

test/fixture/watcher/tap-in-conf/package.json

@@ -0,0 +1,5 @@
+{
+  "ava": {
+    "tap": true
+  }
+}

test/fixture/watcher/tap-in-conf/test.js

@@ -0,0 +1,5 @@
+import test from '../../../../';
+
+test('works', t => {
+	t.pass();
+});