Add outputFile option

[adymorz]

Allow to save a copy of stdout to a file

[sindresorhus]

Why? What's the use-case?

[adymorz]

In my gulp file I have got:

function runRegulatoryTests() {
	return gulp.src([
		"tests/regulatory/commentPeriods.js",
	]).pipe(ava({
		tap: true,
		failFast: argv["ava-failfast"],
		concurrency: parseInt(argv["ava-concurrency"]),
		outputfile: 'tests/output/tapOutput.txt',
		"_":[
			"--",
			"--browser",
			argv["ava-browser"],
			"--headless",
			argv["ava-headless"],
		]
	}));
}

The new option outputfile allows me to store a copy of the stdout (and not stderr) of ava (and nothing more) as a file. This allows me to further process the output (we actually generate a graphical test report containing test descriptions and screenshots).

[sindresorhus]

It seems like this would be better as an option for AVA itself, not just this Gulp plugin.

Can you open an issue on https://github.com/avajs/ava ?

[adymorz]

I just created a ticket in AVA to get a confirmation for the idea: avajs/ava#2431

[adymorz]

After the answer of @novemberborn in the AVA ticket it is a gulp-ava topic again, I guess?

[adymorz]

And alternative approach would be to add an option outputstreams which would allow to pass in one ore more outputstreams. This would allow to use different TAP reportes simultaneously, e.g. faucet for the output in the console (stdout) and ava-tap-json which would get piped to a file write stream.

When streaming the output to the console one should activate the option silent to prevent mixed output.

Both the original approach using outputfile and the newly proposed using outputstreams would extend the current functionality without having a risk to break something.

I personally like the new idea better even though it is a bit harder to understand, because it allows more flexibility. What do you think, @sindresorhus?

[novemberborn]

FWIW I have no interest in maintaining gulp-ava (sorry @adymorz). I'm happy to ship whatever here.

[sindresorhus]

Suggested change

	if (options.outputfile) {
	if (options.outputFile) {

And the option needs to be documented in the readme.

[sindresorhus]

Suggested change

	let filestream = fs.createWriteStream(options.outputfile);
	const fileStream = fs.createWriteStream(options.outputfile);

[sindresorhus]

Alright. Let's add it here then.