gulp-mocha-c8

gulp-mocha-c8 is a gulp plugin that runs mocha tests through c8.

Usage

gulp-mocha-c8 provides a function to run mocha tests with c8 within a gulp task.

var mochaC8 = require('gulp-mocha-c8');

gulp.task('default', () =>
	gulp.src('test.js', {read: false})
		// `gulp-mocha-c8` needs filepaths so you can't have any plugins before it
		.pipe(mochaC8({ 
            mochaOpts: {
                reporter: 'json'
            },
            c8Opts: {
                coverageDirectory: './coverage'
            })
        );
);

API

mochaC8({ c8Opts: { [c8options] }, mochaOpts: { [mochaoptions] } })

c8options

The c8 options are passed directly to its binary and supports the following options:

include

An array of files to include in reporting.

exclude

An array of files to exclude from reporting.

coverageDirectory

The directory to put coverage files. The final output (if not in the terminal) still goes to ./coverage. This options is just for individual coverage files.

mochaoptions

Options are passed directly to the mocha binary, so you can use any its command-line options in a camelCased form. Arrays and key/value objects are correctly converted to the comma separated list format Mocha expects. Listed below are some of the more commonly used options:

ui

Type: string Default: bdd Values: bdd tdd qunit exports

Interface to use.

reporter

Type: string Default: spec Values: Reporters

Reporter that will be used.

This option can also be used to utilize third-party reporters. For example, if you npm install mocha-lcov-reporter you can then do use mocha-lcov-reporter as value.

reporterOptions

Type: Object Example: {reportFilename: 'index.html'}

Reporter specific options.

globals

Type: Array

List of accepted global variable names, example ['YUI']. Accepts wildcards to match multiple global variables, e.g. ['gulp*'] or even ['*']. See Mocha globals option.

timeout

Type: number Default: 2000

Test-case timeout in milliseconds.

bail

Type: boolean Default: false

Bail on the first test failure.

checkLeaks

Type: boolean Default: false

Check for global variable leaks.

grep

Type: string

Only run tests matching the given pattern which is internally compiled to a RegExp.

require

Type: Array

Require custom modules before tests are run.

compilers

Type: string Example: js:babel-core/register

Specify a compiler.

License

MIT License