
Security News
vlt Launches "reproduce": A New Tool Challenging the Limits of Package Provenance
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
js-coverage-badges
Advanced tools
Library to create unit test badges coverage to Javascript and Typescript
This library implements badges for JavaScript test coverage. It supports tests using either Mocha or Jest implementations.
npm i js-coverage-badges
or
yarn add js-coverage-badges
Configure your test library: we support Jest or Mock.
Using:
"nyc": "^15.1.0",
Add the following to your package.json
:
"nyc": {
"extension": [
".js"
],
"reporter": [
"json-summary",
"lcov",
"text"
],
"include": [
"src"
],
"exclude": "**/*.mock.js"
}
Run:
nyc report --reporter=lcov --reporter=text --reporter=json-summary
It is necessary to have the .nyc_output
folder.
Just run:
jest --coverage --coverageReporters="json-summary"
Note:
This commands will create a coverage
folder. It is necessary that the coverage folder
exists in your project to use this library.
Run the command:
npx js-coverage-badges {badges_output}
Example:
npx js-coverage-badges badges_output
This command will create a folder:
└── badges_output
├── branches.svg
├── branches_chart.svg
├── functions.svg
├── functions_chart.svg
├── lines.svg
├── lines_chart.svg
├── statements.svg
└── statements_chart.svg
By default, the tool generates two images for each test type (statements, functions, branches, and lines): one badge and one donut chart. However, you can choose to generate only the badge or only the chart.
To generate only badges (no charts), run:
npx js-coverage-badges badges_output mode:badge
This will create only the badge images:
└── badges_output
├── branches.svg
├── functions.svg
├── lines.svg
└── statements.svg
Add the following code to your README.md to display the badges:
**Test Coverage**
| Statements | Branches | Functions | Lines |
| --------------------------- | ----------------------- | ------------------------- | ----------------- |
|  |  |  |  |
The badges will be displayed like this:
Test Coverage
Statements | Branches | Functions | Lines |
---|---|---|---|
To generate only donut charts (no badges), run:
npx js-coverage-badges badges_output mode:chart
This will create only the chart images:
└── badges_output
├── branches_chart.svg
├── functions_chart.svg
├── lines_chart.svg
└── statements_chart.svg
Add the following code to your README.md to display the charts:
**Test Coverage**
   
The charts will be displayed like this:
Test Coverage
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
git checkout -b feature/AmazingFeature
)git commit -m 'Add some Feature'
)git push origin feature/Feature
)Distributed under the MIT License. See LICENSE.md
for more information.
Created by: @marialuisacp - contato@malu.dev
FAQs
Library to create unit test badges coverage to Javascript and Typescript
The npm package js-coverage-badges receives a total of 0 weekly downloads. As such, js-coverage-badges popularity was classified as not popular.
We found that js-coverage-badges demonstrated a healthy version release cadence and project activity because the last version was released less than 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
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.