karma-istanbul-threshold

Checks coverage thresholds by using json coverage files generated by Istanbul, karma-coverage or karma-remap-istanbul.

While karma-coverage already allows threshold checks, it unfortunately does not play well with source maps.

karma-remap-istanbul can convert results generated by karma-coverage but does not offer threshold checking.

This plugin fills that gap by using a json file for threshold checking that can be generated by Istanbul or karma-coverage (which internally uses Istanbul). Those json files can be remapped by karma-remap-istanbul to enable source-map support for threshold checking.

Installation

The easiest way is to install karma-istanbul-threshold as a devDependency, by running

1npm install karma-istanbul-threshold --save-dev

Configuration

Add the plugin, reporter and reporter configuration in your karma.conf.js.

1{
2  plugins: ['karma-istanbul-threshold'],
3  reporters: ['progress', 'karma-istanbul-threshold'],
4  istanbulThresholdReporter: {
5    src: 'path/to/coverage-report.json',
6    basePath: path.resolve(__dirname, 'path/to/source'),
7    reporters: ['text'], // use 'text' reporter to get text reports like in the screenshot 
8    //reporters: ['teamcity'],  // use 'teamcity' reporter to generate output for teamcity
9    excludes: [
10      'some/module/*.ts' // will exclude .ts files in `path/to/source/some/module`
11    ],
12    thresholds: {
13      global: {
14        statements: 90,
15        branches: 90,
16        lines: 70,
17        functions: 90,
18      },
19      each: {
20        statements: 80,
21        branches: 80,
22        lines: 60,
23        functions: 80,
24      },
25    },    
26  }
27}

Example configuration with karma-coverage and karma-remap-istanbul

1{
2  preprocessors: {
3    'build/**/!(*spec).js': ['coverage']
4  },
5  plugins: ['karma-remap-istanbul', 'karma-coverage', 'karma-istanbul-threshold'],
6  reporters: ['progress', 'coverage', 'karma-remap-istanbul', 'istanbul-threshold'],
7  // Creates coverage reports and stores as json
8  coverageReporter: {
9    reporters: [
10      { type: 'json', dir: 'tmp/coverage', subdir: '.', file: 'coverage-unmapped.json' }
11    ],
12  },
13  // Creates a source-mapped version of coverage report  
14  remapIstanbulReporter: {
15    src: 'tmp/coverage/coverage-unmapped.json',
16    reports: {
17      'json': 'tmp/coverage/coverage-mapped.json'
18    },
19  },
20  // Uses source-mapped version to check coverage thresholds
21  istanbulThresholdReporter: {
22    src: 'tmp/coverage/coverage-mapped.json',
23    basePath: path.resolve(__dirname, 'path/to/source'),
24    reporters: ['text'], 
25    thresholds: {
26      global: {
27        statements: 90,
28        branches: 90,
29        lines: 70,
30        functions: 90,
31      },
32      each: {
33        statements: 80,
34        branches: 80,
35        lines: 60,
36        functions: 80,
37      },
38    },    
39  }
40}