![\"Olavo](\"https://avatars1.githubusercontent.com/u/7513162?v=4\")
Olavo Parno
🤔 💻 ⚠️
![\"nothingismagick\"/](\"https://avatars1.githubusercontent.com/u/35242872?v=4\")
nothingismagick
🤔 🐛 🖋
![\"Dave](\"https://avatars2.githubusercontent.com/u/326470?v=4\")
Dave Fisher
🐛
![](\"https://github.com/olavoparno/olavoparno.github.io/raw/master/images/jest-badges-readme-logo4.png\"){kind=logo}
\n\n# [Jest Badges Readme](https://www.npmjs.com/package/@olavoparno/jest-badges-readme)\n\n[](https://codeclimate.com/github/olavoparno/jest-badges-readme) [](https://david-dm.org/olavoparno/jest-badges-readme/dev-status.svg) [](https://github.com/olavoparno/jest-badges-readme/blob/master/LICENSE) [](https://www.npmjs.com/package/@olavoparno/jest-badges-readme) [](https://github.com/olavoparno/jest-badges-readme/pulls) ![BuiltBy](https://img.shields.io/badge/TypeScript-Lovers-black.svg \"img.shields.io\") ![ForTheBadge](https://img.shields.io/badge/Using-Badges-red.svg \"ForTheBadge\")\n\n### Creates Jest Coverage badges for your README.md file\n\n| Statements | Branches | Functions | Lines | Build Status |\n| -----------|----------|-----------|-------| ------------ |\n| ![Statements](https://img.shields.io/badge/Coverage-96.89%25-brightgreen.svg \"Make me better!\") | ![Branches](https://img.shields.io/badge/Coverage-94.59%25-brightgreen.svg \"Make me better!\") | ![Functions](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg \"Make me better!\") | ![Lines](https://img.shields.io/badge/Coverage-96.89%25-brightgreen.svg \"Make me better!\") | ![BuildStatus](https://img.shields.io/badge/Build-Passing-brightgreen.svg \"Building Status\") |\n\n### TL;DR\n\n- To be short, all it does is: **Creates your README.md dynamically with your Jest Coverage Badges based on your README-template.md file**\n\n### Installation\n\n- Global Installation\n ```bash\n npm i -g @olavoparno/jest-badges-readme\n ```\n\n- Local Installation\n ```bash\n npm i @olavoparno/jest-badges-readme --save-dev\n ```\n\n### Configuration and requirements\n\n 1. Have Jest installed and with its Coverage Reporting configuration as below\n \n - It may be set inside your Jest config within `package.json` or inside your jest config file i.e. `jest.config.js` or `jestconfig.json`\n\n ```js\n \"coverageReporters\": [\n \"json-summary\",\n \"text\",\n \"lcov\"\n ]\n ```\n \n 2. Have a _*README-template.md*_ file created with the following template (please do feel free to change its presentation structure, e.g. in a table or not)\n\n ```md\n | Statements | Branches | Functions | Lines |\n | -----------|----------|-----------|-------|\n | ![Statements](#statements# \"Make me better!\") | ![Branches](#branches# \"Make me better!\") | ![Functions](#functions# \"Make me better!\") | ![Lines](#lines# \"Make me better!\") |\n ```\n\n 3. Call if from your terminal or from your NPM/YARN Scripts\n \n - For locally installed library\n\n ```json\n \"make-badges\": \"node_modules/.bin/jest-badges-readme\"\n ```\n\n - For globally installed library\n\n ```json\n \"make-badges\": \"npm run jest-badges-readme\"\n ```\n\n - You may also provide a different coverage folder path passed as arguments\n\n ```json\n \"make-badges\": \"npm run jest-badges-readme --coverageDir='./my-custom-coverage-folder'\"\n ```\n\n - And finally via the very terminal\n\n ```bash\n jest-badges-readme --coverageDir='./my-custom-coverage-folder'\n ```\n\n### Short summary onto what Jest and Jest Badges Readme covers for us\n\n - % Stmts (which states for Statements)\n - % Branch (pretty self explanatory)\n - % Functions (won't repeat myself)\n - % Lines (last but not least)\n\n#### This library will create badges URLs for these former 4 items into your _*README-template.md*_ if you followed the previous steps\n\n - Open up your _*README-template.md*_ and add 4 _*markers*_ inside it for each Jest coverage item respectively. These _*markers*_ must be as follows:\n\n 1. '#statements#'\n 2. '#branches#'\n 3. '#functions#'\n 4. '#lines#'\n\n#### If you feel you might need a local building badge indicator, add these NPM scripts in order to manage your local building badge as well\n\n ```json\n \"prebuild\": \"echo nok > .buildstatus\",\n \"postbuild\": \"echo ok > .buildstatus\"\n ```\n\n - Add one more marker like the example below. This is going to create a file called _*.buildstatus*_ in your project's root telling this library if your build is either successful or a failure\n 1. '#buildstatus#'\n \n#### Example of _*README-template.md*_ with building status too\n\n ```md\n | Statements | Branches | Functions | Lines | Build Status |\n | -----------|----------|-----------|-------| ------------ |\n | ![Statements](#statements# \"Make me better!\") | ![Branches](#branches# \"Make me better!\") | ![Functions](#functions# \"Make me better!\") | ![Lines](#lines# \"Make me better!\") | ![BuildStatus](#buildstatus# \"Building Status\") |\n ```\n\n### Using as a part of your githooks\n \n - If you want to have this run on the precommit hook and update the commit in place, just install husky and add the `precommit` script to your package.json\n\n 1. Install Husky\n \n ```bash\n npm install --save-dev husky \n ```\n\n 2. Add your precommit script\n \n ```json\n \"husky\": {\n \"hooks\": {\n \"pre-commit\": \"jest && node_modules/.bin/jest-badges-readme && git add 'README.md'\"\n }\n }\n ```\n\n 3. Git Commit and Push. Just use your workflow as usual. If your tests fail, no commit. If they pass, update the README.md and add the file to the commit. Nice!\n\n### Contributing\n\nThe purpose of this library is to motivate developers to constantly write a solid documentation and testing. A complete and nice looking documentation is key to a successful development and code maintainability.\nPlease feel free to open any issues you might come up with and to submit your own PRs. There is not a contributing guide yet\n\n### Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\nOlavo Parno 🤔 💻 ⚠️ | nothingismagick 🤔 🐛 🖋 | Dave Fisher 🐛 |