crimx / coverage-badge-svg

Create SVG badges from code coverage reports, with support for monorepo.

coverage-badge-svg

Create SVG badges from code coverage reports, with support for monorepo.

Example

Usage

Generate coverage with json-summary reporter enabled. For example, with vitest:

vitest --coverage.enabled --coverage.reporter='json-summary'

CLI Usage

npx coverage-badge-svg --out ./docs/coverage

Usage in package

1. Install the package:

   npm install coverage-badge-svg --save-dev

2. package.json:

   {
     "scripts": {
       "coverage-badge": "coverage-badge-svg --out ./docs/coverage"
     }
   }