node-coverage-badges

Generating coverage badges from jest coverage report.

      

⚡ Badges for everyone

This package uses shields.io to created coverage badges from a coverage json summary file generated by your favorite test runner.

Badge	Description
	Percentage of DD-paths followed during tests
	Percentage of functions executed within tests
	Percentage of lines covered by tests
	Percentage of statements executed within tests
	Average of the above coverage percentages

⚡ Github action

If you want to integrate this to your CI/CD, you have a github action available for this.

⚡ Requirements

You need a test runner to generate the report summary file. For example vitest or jest.

⚡ Setup

🔶 Install

1npm i -D node-coverage-badges
2# or
3yarn add -D node-coverage-badges
4# or
5pnpm i -D node-coverage-badges

🔶 Test runner configuration

You will need to add json-summary to coverage reporters in your test runner config.

🧿 vitest

vite config

1import { defineConfig } from 'vitest/config';
2
3export default defineConfig({
4  test: {
5    coverage: {
6      reporter: ['json-summary'],
7      // ...
8    },
9  },
10});

🧿 jest

jest config

1module.exports = {
2   coverageReporters: ["json-summary"];
3   // ...
4};

⚡ Usage

You have two ways to generate coverage badges: cli and node. Both will create a folder where .svg files will be written.

🔶 Cli

You can add a script to your package.json like so:

1  "scripts": {
2    "badges": "generateBadges", // cjs
3    "badges-esm": "generateBadgesEsm" // esm
4  },

The generateBadges function accepts three optional arguments to specify:

• a custom path for the input json summary file.
• a custom path for the output path.
• a simple icon slug to specify a custom badge icon.

1# will generate badges from './coverage/coverage-summary.json' in './badges' (default)
2yarn generateBadges
3
4# will generate badges from './myModule/coverage-summary.json' in './cool' folder.
5yarn generateBadges -c ./myModule/coverage-summary.json -o ./cool
6
7# will generate badges from './myModule/coverage-summary.json' in './cool' folder using the vitest icon.
8yarn generateBadges -c ./myModule/coverage-summary.json -o ./cool -l vitest

🔶 Node

You can generate badges from a summary file or raw values in node.

🧿 Generate badges from a summary file

1import { generateBadges } from 'node-coverage-badges';
2
3(async () => {
4  // will generate badges from './coverage/coverage-summary.json' in './badges' (default)
5  await generateBadges();
6})();

The function optionally accepts two arguments to specify a custom path for the json summary file and the output path:

1import { generateBadges } from 'node-coverage-badges';
2
3(async () => {
4  // will generate badges from './myModule/coverage-summary.json' in './cool' using the jest icon.
5  await generateBadges('./myModule/coverage-summary.json', './cool', 'jest');
6})();

You can also directly import the effect, if you use Effect:

1import { generateBadgesEffect } from 'node-coverage-badges';
2
3const task = Effect.gen(function* () {
4  //...
5
6  const result = yield* generateBadgesEffect();
7});

The function signature is the following:

1const generateBadgesEffect: (
2  coverageSummaryPath?: string,
3  outputPath?: string,
4  logo?: string
5) => Effect.Effect<boolean, FsError | AxiosError, never>;

🧿 Generate badges from raw values

1import { generateBadgesFromValues } from 'node-coverage-badges';
2
3(async () => {
4  const rawValues = {
5    total: {
6      branches: {
7        pct: 25,
8      },
9      functions: {
10        pct: 40,
11      },
12      lines: {
13        pct: 30,
14      },
15      statements: {
16        pct: 70,
17      },
18    },
19  };
20
21  await generateBadgesFromValues(rawValues, './badges', 'vitest');
22})();

Effect signature is the following:

1const generateBadgesFromValuesEffect: (
2  summaryValues: CoverageSummaryValue,
3  outputPath?: string,
4  logo?: string
5) => Effect.Effect<boolean, FsError | AxiosError, never>;

⚡ Thanks

Big thanks to Shield for this awesome tool!