Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 1.79 KB

README.md

File metadata and controls

67 lines (42 loc) · 1.79 KB
Raw

make-coverage-badge

Build Status npm version License

Create a coverage badge

Creates a code coverage badge like the following:

Coverage badge

Currently just reads from Istanbul's JSON summary reporter and downloads a badge from https://shields.io/. Don't expect too much! Send a PR if you need configuration etc.

Usage

(For Create React Apps)

  1. Configure Jest (in package.json):
"jest": {
  "coverageReporters": [
    "json-summary"
  ]
}
  1. Run npm test -- --coverage
  2. Run make-coverage-badge

Resulting badge will be in ./coverage/badge.svg.

Options

--output-path <path>

Writes the coverage badge to the given path (relative to project root). Defaults to ./coverage/badge.svg.

--report-path <path>

Path to a coverage report file. Defaults to ./coverage/coverage-summary.json.

Prior work

  • Coveralls: paid for private repos
  • coverage-badger: same approach, but using an XML report and therefore requires XML dependencies

Author

© 2019 Tom Vincent [email protected] (https://tlvince.com)

License

Released under the MIT license.