karma-new-coverage-reporter

A karma reporter that uses the latest istanbul 1.x APIs (with full sourcemap support) to report coverage.

About

This is a reporter only and does not perform the actual instrumentation of your code. Webpack users should use the istanbul-instrumenter-loader and then use this karma reporter to do the actual reporting. See the test config for an e2e example of how to combine them.

Installation

npm install karma-new-coverage-reporter --save-dev

Configuration

// karma.conf.js
module.exports = function (config) {
 
  config.set({
 
    // ... rest of karma config
 
    // anything named karma-* is normally auto included so you probably dont need this
    plugins: ['karma-new-coverage-reporter'],
 
    reporters: ['new-coverage'],
 
    // any of these options are valid: https://github.com/istanbuljs/istanbul-api/blob/47b7803fbf7ca2fb4e4a15f3813a8884891ba272/lib/config.js#L33-L38
    coverageIstanbulReporter: {
 
       // reports can be any that are listed here: https://github.com/istanbuljs/istanbul-reports/tree/590e6b0089f67b723a1fdf57bc7ccc080ff189d7/lib
      reports: ['html', 'lcovonly', 'text-summary'],
 
       // base output directory
      dir: './coverage',
 
       // if using webpack and pre-loaders, work around webpack breaking the source path
      fixWebpackSourcePaths: true,
 
       // Most reporters accept additional config options. You can pass these through the `report-config` option
      'report-config': {
 
        // all options available at: https://github.com/istanbuljs/istanbul-reports/blob/590e6b0089f67b723a1fdf57bc7ccc080ff189d7/lib/html/index.js#L135-L137
        html: {
          // outputs the report in ./coverage/html
          subdir: 'html'
        }
 
      }
 
    }
 
  });
 
}

List of reporters and options

• clover
• cobertura
• html
• json-summary
• json
• lcov
• lcovonly
• none
• teamcity
• text-lcov
• text-summary
• text

Credits

• Original karma-coverage source
• Example of using the new reporter API
• Karma remap istanbul

License

MIT