coverage-badges-cli

Create coverage badges from coverage reports. Using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers).

Don't worry about thecoverage.io service is down.

Install

$npm i coverage-badges-cli

Example

{"scripts":{"coverage":"jest --coverage""make-badges":"coverage-badges",},"jest":{"collectCoverageFrom":["<rootDir>/packages/**/*.{tsx,ts}","!**/*.{js,d.ts}"],"coverageReporters":["lcov","json-summary"],}}

This config creates a coverage badge in a default directory ./badges.

You can add![Coverage](./coverage/badges.svg) to your README.md after the badge creation.

Github Actions

Input Parameters

• source - The path of the target file "coverage-summary.json".
• output - Output image path.
• label - The left label of the badge, usually static (defaultcoverage).
• labelColor - <Color RGB> or <Color Name> (default:555).
• color - <Color RGB> or <Color Name> (default: '')
• scale - Set badge scale (default:1).
• style - Badges style:flat,classic (defaultclassic).
• type - (No longer supported after v1.2.0) Coverage report type:lines,statements,functions,branches (defaultstatements)
• jsonPath - Path to the coverage percentage number to be used in the badge (defaulttotal.statements.pct)
• arbitrary - AllowjsonPath to point to non-number values. Works in conjunction withjsonPath
• icon - Path to icon file

-name: Create Coverage Badgesuses: jaywcjlove/coverage-badges-cli@mainwith:style: flatsource: coverage/coverage-summary.jsonoutput: coverage/badges.svgjsonPath: totals.percent_covered-name: Deployuses: peaceiris/actions-gh-pages@v3with:github_token: ${{ secrets.GITHUB_TOKEN}}publish_dir: ./build

Output Parameters

svg svg image string:<svg xmlns.....

Using the command line

name: Build & Deployon:push:branches:- masterjobs:build-deploy:runs-on: ubuntu-18.04steps:-uses: actions/checkout@v2-uses: actions/setup-node@v2with:node-version:14-run: npm install-run: npm run build-run: npm run coverage-run: npm i coverage-badges-cli-g-run: coverage-badges--output coverage/badges.svg-name: Deployuses: peaceiris/actions-gh-pages@v3if: github.ref == 'refs/heads/master'with:github_token: ${{ secrets.GITHUB_TOKEN}}publish_dir: ./coverage

Command Help

Usage: coverage-badges[options][--help|h]Options:  --version,-v  Show version number  --help,-h     Displayshelp information.  --output,-o   Output directory.  --source,-s   The path of the targetfile"coverage-summary.json".--style        Badges style: flat, flat-square.--type         Coverage type: lines, statements, functions, branches.--scale        Set badge scale(default:1)--icon         Path to iconfile--iconWidth    Set thisif icon is not square(default:13)--label        The left label of the badge, usually static(default`coverage`).--labelColor<Color RGB> or<Color Name>(default:'555')--color<Color RGB> or<Color Name>(default:'')--jsonPath     Path to the coverage percentage number to be usedin the badge.--arbitrary    Allow jsonPath to point to non-number values. Worksin conjunction with jsonPath.Example:npm coverage-badges-cli--output coverage/badges.svgnpm coverage-badges-cli--style plasticnpm coverage-badges-cli--source coverage/coverage-summary.jsonnpm coverage-badges-cli--labelColor ADF

Development

$npm i$npm run build$npm runwatch

See also

• Github Release Changelog Generator A GitHub Action that compares the commit differences between two branches
• Create Tags From Auto create tags from commit or package.json.
• Github Action Contributors Github action generates dynamic image URL for contributor list to display it!
• Create Coverage Badges Create coverage badges from coverage reports. (no 3rd parties servers)
• Generated Badges Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)

Contributors

As always, thanks to our amazing contributors!

Made withcontributors.

License

MIT ©Kenny Wong