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

1generateBadges -c [coverageJsonSummaryPath] -o [outputPath] -l [logo]
2
3Options:
4      --help     Show help                                             [boolean]
5      --version  Show version number                                   [boolean]
6  -c             coverage file path[default: "./coverage/coverage-summary.json"]
7  -o             output path                               [default: "./badges"]
8  -l             vitest                                [default: <default icon>]
9  -p             badges label prefix                  [default: "Test coverage"]
10  -d             debug                                          [default: false]
11
12Examples:
13  generateBadges -c ./coverage/coverage-summary.json -o ./badges -l vitest
14
15Generates badges from a coverage report
16

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)
2pnpm generateBadges
3
4# will generate badges from './myModule/coverage-summary.json' in './cool' folder.
5pnpm 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.
8pnpm generateBadges -c ./myModule/coverage-summary.json -o ./cool -l vitest
9
10# will generate badges from './myModule/coverage-summary.json' in './cool' folder using the vitest icon with badges labels matching 'Repo test coverage: %d'.
11pnpm generateBadges -c ./myModule/coverage-summary.json -o ./cool -l vitest -p 'Repo test coverage'

🔶 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// will generate badges from './coverage/coverage-summary.json' in './badges' (default)
4await generateBadges();

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// will generate badges from './myModule/coverage-summary.json' in './cool' using the jest icon.
4await generateBadges(
5  './myModule/coverage-summary.json',
6  './cool',
7  'jest',
8  'My badges labels prefix'
9);

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  labelPrefix?: string
6) => Effect.Effect<boolean, FsError | AxiosError, never>;

🧿 Generate badges from raw values

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

Effect signature is the following:

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

🧿 Debug

You can pass a boolean as last argument to get generation info:

1import { generateBadges } from 'node-coverage-badges';
2
3await generateBadges(
4  './myModule/coverage-summary.json',
5  './cool',
6  'jest',
7  'My badges labels prefix'
8  true
9);

Which will provide the following kind of output:

⚡ Thanks

Big thanks to Shield for this awesome tool!