https://github.com/fdesjardins/coverage-viewer
A cross-platform code coverage report generator
https://github.com/fdesjardins/coverage-viewer
coverage coverlet html json report server viewer
Last synced: 26 days ago
JSON representation
A cross-platform code coverage report generator
- Host: GitHub
- URL: https://github.com/fdesjardins/coverage-viewer
- Owner: fdesjardins
- License: mit
- Created: 2018-04-18T23:20:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T07:23:15.000Z (over 2 years ago)
- Last Synced: 2024-08-10T23:13:28.177Z (9 months ago)
- Topics: coverage, coverlet, html, json, report, server, viewer
- Language: JavaScript
- Homepage:
- Size: 1.33 MB
- Stars: 15
- Watchers: 2
- Forks: 4
- Open Issues: 15
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Coverage Viewer
[![npm version][npm-version-image]][npm-version-url]
[![Build Status][travis-image]][travis-url]
[![Coverage][coveralls-image]][coveralls-url]
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 [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](https://github.com/fdesjardins)
[npm-version-image]: https://img.shields.io/npm/v/coverage-viewer.svg
[npm-version-url]: https://www.npmjs.com/package/coverage-viewer
[travis-url]: https://travis-ci.org/fdesjardins/coverage-viewer
[travis-image]: https://img.shields.io/travis/fdesjardins/coverage-viewer.svg?style=flat
[coveralls-url]: https://coveralls.io/r/fdesjardins/coverage-viewer
[coveralls-image]: https://img.shields.io/coveralls/fdesjardins/coverage-viewer.svg?style=flat