karma-js-coverage travis-ci grunt npm

A Karma plugin. Generate code coverage.

5 years after

karma-coverage

Generate code coverage using Istanbul.

This is a fork of the excellent karma-coverage plugin. This simply removes the CoffeeScript coverage option, which is temporarily needed as the dependencies in the Coffee coverage modules are causing problems for some projects.

Installation

The easiest way is to keep karma-coverage as a devDependency in your package.json.

{
  "devDependencies": {
    "karma": "~0.10",
    "karma-js-coverage": "~0.2.0"
  }
}

You can simple do it by:

npm install karma-js-coverage --save-dev

Configuration

Following code shows the default configuration...

// 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/'
    }
  });
};

Options

type

Type: String

Possible Values:

  • html (default)
  • lcov (lcov and html)
  • lcovonly
  • text
  • text-summary
  • cobertura (xml format supported by Jenkins)
  • teamcity (code coverage System Messages for TeamCity)

If you set type to text or text-summary, you may set the file option, like this.

coverageReporter: {
  type : 'text',
  dir : 'coverage/',
  file : 'coverage.txt'
}

If no filename is given, it will write the output to the console.

dir

Type: String

Description: This will be used to output coverage reports. When you set a relative path, the directory is resolved against the basePath.

multiple reporters

You can use multiple reporters, by providing array of options.

coverageReporter: {
  reporters:[
    {type: 'html', dir:'coverage/'},
    {type: 'teamcity'},
    {type: 'text-summary'}
  ],
}

For more information on Karma see the homepage.

Related Repositories

karma-coverage

karma-coverage

A Karma plugin. Generate code coverage. ...

Prebid.js

Prebid.js

Setup and manage header bidding advertising partners without writing code or con ...

karma-junit-reporter

karma-junit-reporter

A Karma plugin. Report results in junit xml format. ...

pact-js

pact-js

Pact JS DSL ...

babel-jspm-karma-jasmine-istanbul

babel-jspm-karma-jasmine-istanbul

Babel JSPM Karma Jasmine Istanbul Coverage example and tutorial ...


Top Contributors

vojtajina danielflower dignifiedquire abierbaum joseph-connolly can3p chrisgladd juliemr mrzepinski manevpe kombucha Constellation aprooks

Releases

-   v0.4.0 zip tar
-   v0.3.0 zip tar
-   v0.2.3 zip tar
-   v0.2.2 zip tar
-   v0.2.1 zip tar
-   v0.2.0 zip tar
-   v0.1.5 zip tar
-   v0.1.4 zip tar
-   v0.1.3 zip tar
-   v0.1.2 zip tar
-   v0.1.1 zip tar
-   v0.1.0 zip tar
-   v0.0.5 zip tar
-   v0.0.4 zip tar
-   v0.0.3 zip tar