vinicioslc / jest-badge-generator

📛 A little cli that generates svg badges from your library using jest summary json and put into `.badges` folder.

Jest Badges Generator

This has inteded to be an package that generates jest badges to be used by your README.md or something like.

By default all badges are sended to .badges the files will be something like..

has option for convert to png too...

badge-branches.svg

badge-functions.svg

badge-lines.svg

badge-statements.svg

How to

0. Install this package as development dependency npm i jest-badge-generator -D

1. you will need add follwing config to your jest tests section in package.json or in your jest.config.js

...
  "scripts": {
    "test": "jest --coverage",
    "test:make-badges": "npm run test && jest-badge-generator" // you have the options argument to convert for png with `jest-badge-generator --type "png"` this will convert output svg to png
  },
  "jest": {
    "coverageReporters": [
        "json",
        "json-summary",
        "lcov",
        "text",
        "text-summary"
    ],
    "testPathIgnorePatterns": [
        "/node_modules/"
    ],
    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.jsx?$"
  },
...

2. Run the tests npm run test:make-badges

Library Jest Health Summary