You want to just plug and play something to have a cool and very meaningful test coverage badge on your README. Or you have a private repo and don't want to integrate with any SaaS.
Currently only clover reports. Working to bring all the standard reporters and even let you input your own.
The first time you need to add a placeholder on your destination file. Can be both markdown or HTML:
![badgifier-cobertura]
Then because Badgifier is a cli command just execute it:
badgifier -i coverage/clover.xml -o README.md
What params the cli accepts:
| option | alias | default | description |
|---|---|---|---|
format | f | 'markdown' | In which language your placeholder is (md or html) |
input | i | './coverage/clover.xml' | From where to read coverage report |
output | o | console.log | Where to send the badge |
rate | r | (Internal) | Which formula will use to calculate the value |
threshold-high | th | 95 | From which value is a green situation |
threshold-low | tl | 65 | Until which value is a red situation |
Right now we're really interesting into knowing which reporters will you want to be supported out of the box. And also, what's broken when you use it. So, open as many issues as you feel like 🕵🏽♀️
And, of course, any PR is more than welcome :P
FAQs
Generate badges without third-parties services
The npm package badgifier receives a total of 2 weekly downloads. As such, badgifier popularity was classified as not popular.
We found that badgifier demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
