grunt-mocha-istanbul

Almost config-free Istanbul code coverage reporter for Mocha usage in Grunt

npm install grunt-mocha-istanbul
18 downloads in the last day
185 downloads in the last week
792 downloads in the last month

Dependency Status

NPM

grunt mocha istanbul task

Mocha reporter to generate coverage report of istanbul instrumented code, for grunt This doesn't force you to use PhantomJS, or instrument code for server or client-side.

Install

  1. Install it using npm install grunt-mocha-istanbul --save-dev
  2. It needs mocha and grunt to be installed locally on your project (aka, having them in your devDependencies)
  3. Call inside Gruntfile.js grunt.loadNpmTasks('grunt-mocha-istanbul')

Changes from 0.2.0

  • mocha_istanbul_check was removed and became part of the options under the check object

Options

Most of the options that you pass to mocha is available in options:


module.exports = function(grunt){
    grunt.initConfig({
        mocha_istanbul: {
            coverage: {
                src: 'test', // the folder, not the files,
                options: {
                    mask: '*.spec.js'
                }
            },
            coveralls: {
                src: 'test', // the folder, not the files
                options: {
                    coverage:true,
                    check: {
                        lines: 75,
                        statements: 75
                    },
                    root: './lib', // define where the cover task should consider the root of libraries that are covered by tests
                    reportFormats: ['cobertura','lcovonly']
                }
            }
        }
    });

    grunt.event.on('coverage', function(lcovFileContents, done){
        // Check below
        done();
    });

    grunt.loadNpmTasks('grunt-mocha-istanbul');

    grunt.registerTask('coveralls', ['mocha_istanbul:coveralls']);
    grunt.registerTask('coverage', ['mocha_istanbul:coverage']);
};

If there's a mocha.opts file inside the src, it will warn if you are overwritting any options.

Coverage is written to coverage folder by default, in the same level as the Gruntfile.js

The check will fail the build if the thresholds are not met. It's a great possibility for CI-builds.

Options

Array options.require (default: [])
Boolean options.ui (default: false)
Array options.globals (default: [])
String options.reporter (default: false)
Number options.timeout (default: false)
Boolean options.slow (default: false)
String options.grep (default: false)
Boolean options.recursive (default: false)
Boolean options.noColors (default: false)

Mochas parameters, check [http://visionmedia.github.io/mocha/#usage]

Array options.mochaOptions (default: false)

Any additional mocha parameters, manually set

Array options.istanbulOptions (default: false)

Any additional istanbul parameters, manually set

Boolean options.coverage (default: false)

Setting this to true makes the task emit a grunt event coverage, that will contain the lcov data from the file, containing the following callback function(lcovcontent, done), and you must manually call done() when you are finished, else the grunt task will hang. See more information below

Boolean options.dryRun (default: false)

Spits out the command line that would be called, just to make sure everything is alright

Array options.excludes (default: false)

Setting this exclude files from coverage report, check istanbul help cover. You may use glob matching in here.

String options.mask (default: false)

The mask for the tests to be ran. By default, mocha will execute the test folder and all test files

Boolean options.quiet (default: false)

Suppresses the output from Mocha and Istanbul

String options.coverageFolder (default: coverage)

Name of the output of the coverage folder

Array options.reportFormats (default: ['lcov'])

Name of report formats. You can specify more than one. If you intend to use the coverage option to true or do any checks, you must add: ['yourformat','lcovonly'], since it's needed for the lcov.info file to be created.

Supported formats:

    html - produces a bunch of HTML files with annotated source code
    lcovonly - produces an lcov.info file
    lcov - produces html + lcov files. This is the default format
    cobertura - produces a cobertura-coverage.xml file for easy Hudson integration
    text-summary - produces a compact text summary of coverage, typically to console
    text - produces a detailed text table with coverage for all files
    teamcity - produces service messages to report code coverage to TeamCity
String options.root (default: false)

The root path to look for files to instrument, defaults to .. Can help to exclude directories that are not part of the code whose coverage should be checked.

String options.print (default: false)

The type of report to print to console. Can be one of 'summary', 'detail', 'both', or 'none'. By default, Istanbul will print the 'summary' report.

Number options.check.statements (default: false)

Number of statements threshold to consider the coverage valid

Number options.check.lines (default: false)

Number of lines threshold to consider the coverage valid

Number options.check.branches (default: false)

Number of branches threshold to consider the coverage valid

Number options.check.functions (default: false)

Number of functions threshold to consider the coverage valid

The coverage event

When you set the option coverage to true, you'll receive the coverage/lcov.info file contents:

grunt.event.on('coverage', function(lcov, done){
    console.log(lcov);
    done(); // or done(false); in case of error
});

This is mainly useful so you can send it to, for example, coveralls (using coveralls):

grunt.event.on('coverage', function(lcov, done){
    require('coveralls').handleInput(lcov, function(err){
        if (err) {
            return done(err);
        }
        done();
    });
});

This way, Travis-CI can send the Istanbul generated LCOV directly to Coveralls.io website in this example, but you could create any transform for Jenkins, TeamCity, Hudson, etc.

npm loves you