Choose Badges Readme

Creates README badges from coverage and tests reports

Table of Contents

• Requirements
• Installation
• Simple Usage
• Advanced Usage
• License

Requirements

• First, of course, you must have a test runner such as Jest and Mocha;
• You must have json-summary as a coverageReporter in your tests configuration;
• You must have ./coverage/tests-summary.json at outputFile in your tests configuration;
• You must have --json set in your tests configuration;
• For example, if you are using Jest, configuration should either be within package.json or inside your jest config file i.e. jest.config.js or jestconfig.json as written below:

  "outputFile": "./coverage/tests-summary.json",
  "coverageReporters": ["json-summary"],

and add into package.json:

 "scripts": {
    "start": "...",
    "test": "jest --config jestconfig.json --passWithNoTests --json",
    ...
 }

Installation

• Install the library in your project as a devDependency:

  yarn add @choose/make-badges --dev

• Add at least one of the below badge hashes in your README file:

  • ![Tests](#tests#)
  • ![Statements](#statements#)
  • ![Branches](#branches#)
  • ![Functions](#functions#)
  • ![Lines](#lines#)

Simple Usage

• Simply run it from the CLI as follows:

  yarn run choose-make-badges

• Or add it to your package.json scripts as follows:

"scripts": {
  "make-badges": "choose-make-badges",
}

Advanced Usage

• Custom coverage directory? Use --coverageDir argument:

  yarn run choose-make-badges --coverageDir="./my-custom-coverage-directory"

• Custom readme directory? Use --readmeDir argument:

  yarn run choose-make-badges --readmeDir="./my-custom-readme-directory"

• Want it without logging? Try silent mode with --silent argument:

  yarn run choose-make-badges --silent

• You may also create custom labeling for the badges using the corresponding hash and Label e.g. branchesLabel --branchesLabel='Branches are troublesome!':

  yarn run choose-make-badges --functionsLabel='Mis funciones!' --branchesLabel='Branches are troublesome!'

License

@Choose Badges Readme is MIT licensed.