Gathering detailed insights and metrics for node-jest-badges
Gathering detailed insights and metrics for node-jest-badges
Installations
npm install node-jest-badgesDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
20.x
Node Version
20.11.0
NPM Version
10.2.4
Releases
Unable to fetch releases
Languages
2
TypeScript
JavaScript
TypeScript (81.82%)
JavaScript (18.18%)
Developer
jpb06
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
4 Stars
176 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Feb 13, 2024
Maintainers
1
Package Meta Information
Latest Version
1.3.17
Package Id
node-jest-badges@1.3.17
Unpacked Size
25.60 kB
Size
7.29 kB
File Count
42
NPM Version
10.2.4
Node Version
20.11.0
Published on
Feb 13, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
29
@jest/types@stylistic/eslint-plugin@swc/core@swc/jest@types/fs-extra@types/jest@types/node@types/yargs@typescript-eslint/eslint-plugin@typescript-eslint/parsercopyfilesdel-clieslinteslint-config-prettiereslint-import-resolver-typescripteslint-plugin-importeslint-plugin-jesteslint-plugin-jest-domeslint-plugin-markdowneslint-plugin-prettierjestjest-watch-typeaheadprettierreadme-package-iconsts-nodets-paths-transformtsconfig-pathstscpathstypescript
node-jest-badges
Generating coverage badges from jest coverage report.
😺 This library is replaced by node-coverage-badges
⚡ Badges for everyone
Let's just imagine you want to display some information about your testing coverage and you're using jest as a testing framework. Look no further!
⚡ Badges?
This package generates the following badges for you, based on the coverage report generated by jest, using instanbul.
| Badge | Description |
|---|---|
 | Percentage of DD-paths followed during tests |
 | Percentage of functions executed within tests |
 | Percentage of lines covered by tests |
 | Percentage of statements executed within tests |
| Average of the above coverage percentages |
⚡ Github action
If you want to integrate this to your CI/CD, you have a github action available for this.
⚡ Requirements
🔶 Jest
Well, let's just start by stating the obvious here. Yes, you will need jest testing library to use this package.
⚡ Setup
🔶 Install
1yarn add -D node-jest-badges
or
1npm i -D node-jest-badges
🔶 Jest configuration
You will need to add json-summary to coverage reporters in jest config:
1module.exports = { 2 coverageReporters: ["json-summary"]; 3};
⚡ Usage
You have two ways to generate coverage badges: cli and node. Both will create a folder where .svg files will be written.
🔶 Cli
You can add a script to your package.json like so:
1 "scripts": { 2 "badges": "generateBadges" 3 },
The generateBadges function accepts two optional arguments to specify:
- a custom path for the input json summary file.
- a custom path for the output path.
1// will generate badges from './coverage/coverage-summary.json' in './badges' (default) 2yarn generateBadges 3 4// will generate badges from './myModule/coverage-summary.json' in './cool' folder. 5yarn generateBadges -c ./myModule/coverage-summary.json -o ./cool
🔶 Node
Another way is to directly use the package:
1import { generateBadges } from 'node-jest-badges'; 2 3(async () => { 4 // will generate badges from './coverage/coverage-summary.json' in './badges' (default) 5 await generateBadges(); 6})();
The function optionally accepts two arguments to specify a custom path for the json summary file and the output path:
1import { generateBadges } from 'node-jest-badges'; 2 3(async () => { 4 // will generate badges from './myModule/coverage-summary.json' in './cool' 5 await generateBadges('./myModule/coverage-summary.json', './cool'); 6})();
⚡ Thanks
Big thanks to Shield for this awesome tool!
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/tests-scan.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests-scan.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/tests-scan.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests-scan.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/tests-scan.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests-scan.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/tests-scan.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests-scan.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/tests-scan.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests-scan.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/jpb06/node-jest-badges/tests-scan.yml/master?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 7 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Score
2.5
/10
Last Scanned on 2025-06-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More