coverage-viewer

Coverage Viewer

Turn your code coverage output into a website for exploring your project's coverage statistics more easily:

Installation

npm i -g coverage-viewer

Usage

Currently only tested with C# coverlet JSON output.

CLI Usage:

Usage: coverage-viewer <coverageFile> [options]

Options:
  -s             The root of your project's source code directory     [required]
  -o             Where coverage-viewer should write output
  -u, --up       Whether to start the express viewing server           [boolean]
  -v, --version  Show version number                                   [boolean]
  -h, --help     Show help                                             [boolean]

Examples:
  coverage-viewer coverage.json -s ./src -o ./coverage

Using the -u or --up flags, you can run an express app to view the output, and automatically re-run the generator if the coverage file changes.

coverage-viewer coverage.json -s ./src -o ./coverage --up

Alternatively, once you've generated the output, serve it with your preferred server:

npm i -g httpserver
cd coverage
httpserver

License

MIT © Forrest Desjardins