karma-coverage
Generate code coverage using Istanbul .
Installation
The easiest way is to install karma-coverage as a devDependency,
by running
npm install karma karma-coverage --save-dev copy
Configuration
For configuration details see docs/configuration .
Examples
Basic
// karma.conf.js
module . exports = function (config) {
config. set ({
files: [
'src/**/*.js' ,
'test/**/*.js'
],
// coverage reporter generates the coverage
reporters: [ 'progress' , 'coverage' ],
preprocessors: {
// source files, that you wanna generate coverage for
// do not include tests or libraries
// (these files will be instrumented by Istanbul)
'src/**/*.js' : [ 'coverage' ]
},
// optionally, configure the reporter
coverageReporter: {
type : 'html' ,
dir : 'coverage/'
}
});
};
CoffeeScript
For an example on how to use with CoffeeScript
see examples/coffee . For an example of how to use with
CoffeeScript and the RequireJS module loader, see
examples/coffee-requirejs (and also see
the useJSExtensionForCoffeeScript option in
docs/configuration.md ).
Advanced, multiple reporters
// karma.conf.js
module . exports = function (config) {
config. set ({
files: [
'src/**/*.js' ,
'test/**/*.js'
],
reporters: [ 'progress' , 'coverage' ],
preprocessors: {
'src/**/*.js' : [ 'coverage' ]
},
coverageReporter: {
// specify a common output directory
dir: 'build/reports/coverage' ,
reporters: [
// reporters not supporting the `file` property
{ type: 'html' , subdir: 'report-html' },
{ type: 'lcov' , subdir: 'report-lcov' },
// reporters supporting the `file` property, use `subdir` to directly
FAQ
Don't minify instrumenter output
When using the istanbul instrumenter (default), you can disable code compaction by adding the following to your configuration.
// karma.conf.js
module . exports = function (config) {
config. set ({
coverageReporter: {
instrumenterOptions: {
istanbul: { noCompact: true }
}
}
});
}; copy
For more information on Karma see the homepage .