Create coverage badges from different coverage reports
npm install coverage-badgesCreate coverage badges from different coverage reports.
Coverage badge examples:
!Coverage !Ruby coverage !JS coverage
yarn add --dev coverage-badges
`or
`
npm install --save-dev coverage-badges
`Configuration
Create
.coveragebadgesrc file in JSON format.$3
####
.coveragebadgesrc example
`json
{
"source": "./coverage/coverage-summary.json",
"attribute": "total.statements.pct"
}
`####
packadge.json example
`json
"scripts": {
"premake-badge": "$(yarn bin)/jest --coverage",
"make-badge": "$(yarn bin)/coverage-badges",
},
"jest": {
"coverageReporters": [
"text",
"lcov",
"json-summary"
],
}
`Run
`
yarn make-badge
`This config creates a coverage badge in a default directory
./badges.You can add
!Coverage to your README.md after the badge creation.
$3
####
.coveragebadgesrc example
`json
[
{
"label": "JS coverage",
"source": "./coverage/coverage-summary.json",
"attribute": "total.statements.pct",
"outputDir": "./my_badges_dir"
},
{
"label": "Ruby coverage",
"source": "./coverage/.last_run.json",
"attribute": "result.covered_percent",
"outputDir": "./my_badges_dir"
}
]
`####
packadge.json example
`json
"scripts": {
"premake-badges": "$(yarn bin)/jest --coverage && COVERAGE=true rails test",
"make-badges": "$(yarn bin)/coverage-badges",
},
"jest": {
"coverageReporters": [
"text",
"lcov",
"json-summary"
],
}
`Run
`
yarn make-badges
`This config creates coverage badges in the custom directory
./my_badges_dir.You can add
!JS coverage and !Ruby coverage` to your README.md after badges creation.