A browserify transform for the istanbul code coverage tool
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
testdata
.editorconfig
.eslintrc
.gitignore
.npmignore
.travis.yml
README.md
index.js
package.json

README.md

browserify-istanbul

A browserify transform for the istanbul code coverage tool.

Installing

npm install --save-dev browserify-istanbul

Usage

There are several ways to register browserify transforms: on the command line, in your package.json, or using the browserify API. You can use all of these with browserify-istanbul: see the browserify docs for more info.

There are a few options available to browserify-istanbul when you use it from JavaScript. They are shown in the following code example:

var istanbul = require('browserify-istanbul');

// use without any options...
browserifyBundle.transform(istanbul);

// or with some options...
browserifyBundle.transform(istanbul({
  // ignore these glob paths (the ones shown are the defaults)
  ignore: ['**/node_modules/**', '**/bower_components/**', '**/test/**', '**/tests/**', '**/*.json'],

  // by default, any paths you include in the ignore option are ignored
  // in addition to the defaults. set the defaultIgnore option to false
  // to only ignore the paths you specify.
  defaultIgnore: true
}));

Command line

  • without options:
./node_modules/.bin/browserify -t browserify-istanbul test/test-*.js -o bundle.js
  • with options
./node_modules/.bin/browserify -t [ browserify-istanbul --ignore "**/bower_components/**" ] test/test-*.js -o bundle.js

Interacting With Coverage Reports

To load and manipulate coverage reports, the command line tool nyc can be used:

  1. output the the __coverage__ object to ./.nyc_output/coverage.json.
  1. execute nyc with a list of reporters.
  • nyc report --reporter=lcov --reporter=text-summary.

See istanbul.js.org for more examples and documentation.

License

MIT