Coverage Summary

Summarize istanbul coverage report for specific folders

Installation

npm install @rianbotha/coverage-summary -g

Usage

coverage-report <filename> [options]

Example

coverage-report ./clover.xml --config ./.coverage-summary.js

Example output

Summary for report generated on 19/11/2019, 08:02:31
┌───────────┬─────────┬───────┬────────────┐
│ Section   │ Covered │ Lines │ Coverage % │
├───────────┼─────────┼───────┼────────────┤
│ All Files │    8087 │ 10215 │     79.17% │
│ Account   │     148 │   174 │     85.06% │
│ Checkout  │     465 │   869 │     53.51% │
└───────────┴─────────┴───────┴────────────┘

Filename

Path to a clover.xml report generated by Istanbul

Options

Config

Path to a config file. If no config file is supplied, you will only get a summary for All Files.

It should be in the following format:

module.exports = {
  bundles: [
    {
      path: ['src/bundles/account', 'src/bundles/other],
      name: 'Account',
    },
    {
      path: ['src/bundles/checkout'],
      name: 'Checkout',
    },
  ],
  threshold: [50, 75],
};

Each bundle should contain a path. This is an array of starting paths for parts of the report to summarize together. src/sample will combine coverage numbers for src/sample and any sub-directories eg. src/sample/component

name is optional and will be used in the summary table. The first entry in path will be used if name is not defined.

threshold is used to colour code percentage values. Anything below the first number will be red. Below the second number will be yellow. And above the second number will be green. The default value is [50, 75].

Limitations

Coverage can only be tracked at folder level. You can't summarize based on individual files.