grunt-istanbul

JavaScript codecoverage tool for Grunt

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
grunt-istanbul
107140.8.07 years ago11 years agoMinified + gzip package size for grunt-istanbul in KB

Readme

grunt-istanbul Build Status
JavaScript codecoverage tool for Grunt

Getting Started

This plugin requires Grunt ~0.4.1 Install this grunt plugin next to your project's Gruntfile.jsgettingstarted with: npm install grunt-istanbul Then add this line to your project's Gruntfile.js gruntfile: ```javascript grunt.loadNpmTasks('grunt-istanbul'); ```

Documentation

To use this grunt-istanbul plugin, register a grunt task to run the following:
  1. Instrument your source code
  1. Run your test suite against your instrumented source code
  1. Store your coverage results
  1. Make the report
For step 2, an environment variable can be used to determine which path to use for loading the source code to run the tests against. For example, when you normally run your tests you want them to point directly at your source code. But when you run your instanbul code coverage task you want your tests to point at your instrumented source code. The grunt-env plugin can be used for setting an environment variable in a grunt task. Here's an example solution that solves this problem using grunt-env and grunt-mocha-test: ```javascript // in Gruntfile.js module.exports = function (grunt) { grunt.initConfig({
env: {
coverage: {
APP_DIR_FOR_CODE_COVERAGE: '../test/coverage/instrument/app/'
}
},
instrument: {
files: 'app/*.js',
options: {
lazy: true,
basePath: 'test/coverage/instrument/'
}
},
mochaTest: {
options: {
reporter: 'spec'
},
src: ['test/*.js']
},
storeCoverage: {
options: {
dir: 'test/coverage/reports'
}
},
makeReport: {
src: 'test/coverage/reports/**/*.json',
options: {
type: 'lcov',
dir: 'test/coverage/reports',
print: 'detail'
}
}
}); grunt.registerTask('coverage', 'env:coverage', 'instrument', 'mochaTest',
'storeCoverage', 'makeReport']);
}; ``` ```javascript // requirehelper.js module.exports = function (path) { return require((process.env.APPDIRFORCODECOVERAGE || '../app/') + path); }; ``` ```javascript // using requireHelper in a test var requireHelper = require('../requirehelper'); var formValidator = requireHelper('formvalidator'); ``` You can also pass an instrumenter argument to the instrument options as well as any other arguments that your instrumenter takes. ```javascript // in Gruntfile.js module.exports = function (grunt) { var isparta = require('isparta'); grunt.initConfig({
instrument: {
files: 'app/*.es6',
options: {
lazy: true,
basePath: 'test/coverage/instrument/'
babel: {ignore: false, experimental: true, extensions: ['.es6']},
instrumenter: isparta.Instrumenter
}
}
}); }; ``` If you want to specify a current working directory, you can specify a path the cwd options : ```javascript // in Gruntfile.js module.exports = function (grunt) { var isparta = require('isparta'); grunt.initConfig({
instrument: {
files: '**/*.es6',
options: {
cwd: 'app/'
lazy: true,
basePath: 'test/coverage/instrument/'
babel: {ignore: false, experimental: true, extensions: ['.es6']}
}
}
}); }; ``` If you wan to insturment multiple locations, you specify multiple task targets: ```javascript // in Gruntfile.js module.exports = function (grunt) { grunt.initConfig({
env: {
coverage: {
APP_DIR_FOR_CODE_COVERAGE: '../test/coverage/instrument/app/'
}
},
instrument: {
api: {
files: 'app/*.js',
options: {
basePath: 'test/coverage/instrument/'
}
},
web: {
files: 'web/*.js',
options: {
basePath: 'test/coverage/instrument/'
}
}
},
mochaTest: {
options: {
reporter: 'spec'
},
src: ['test/*.js']
},
storeCoverage: {
options: {
dir: 'test/coverage/reports'
}
},
makeReport: {
src: 'test/coverage/reports/**/*.json',
options: {
type: 'lcov',
dir: 'test/coverage/reports',
print: 'detail'
}
}
}); grunt.registerTask('coverage', function(arg) {
var insturment = arg ? 'insturment:' + arg : 'insturment';
grunt.task.run(['env:coverage', instrument, 'mochaTest',
'storeCoverage', 'makeReport']);
}); ``` ```bash
coverage with api and web insturmentation
$ grunt coverage
coverage with api insturmentation
$ grunt coverage:api
coverage with web insturmentation
$ grunt coverage:web ``` By default only files that have coverage are stored. When the 'include-all-sources' option is set to true it will show all instrumented files even if their coverage percentage is 0. To see all instrumented files you can init the storeCoverage task as follows: ```javascript grunt.initConfig({ storeCoverage: {
options: {
dir: 'test/coverage/reports',
'include-all-sources': true
}
} }); ``` Also, checkout the example Gruntfile.js in this repo (note that you do not need to implement the reloadTasks task in this example):
Gruntfile.js

more examples

* [gregjopa/express-app-testing-demo](https://github.com/gregjopa/express-app-testing-demo)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using gruntgrunt.

Release History

(Nothing yet)

License

Copyright (c) 2014 taichi Licensed under the MIT license.