pamepeixinho / jest-coverage-badges

Create jest coverage badges (from all jest types)

Hi 👋

I'm currently Software Engineer Manager at QuintoAndar.

Love to talk about: productivity, quality, leadership and documentation

👉 take a look on my profile here 👈

jest-coverage-badges's Issues

[IMPORTANT] New maintained package fork - here

Hi guys
Since this repo is not updated anymore (and we actively use it)
I forked it and published on npm
https://www.npmjs.com/package/jest-coverage-badges-ng

If you want to use it
npm i jest-coverage-badges-ng

I promise that we will continue to maintain and update it.
I will merge the merge requests from this repo

ping me if you want to participate
[email protected]

Create unit test

Just wanted to say thank you! useful stuff.

You close it :)) Just an appreciation.

Update `makedir` dependency to resolve known security issue

Security vulnerability in mkdir dependency

Summary

TL;DR: jest-coverage-badges depends on an outdated version of mkdir with security vulnerabilities
Age: LEGACY

Estimated cost: SIMPLE

Description 📋

run npm audit

                       === npm audit security report ===                        
                                                                                
┌──────────────────────────────────────────────────────────────────────────────┐
│                                Manual Review                                 │
│            Some vulnerabilities require your attention to resolve            │
│                                                                              │
│         Visit https://go.npm.me/audit-guide for additional guidance          │
└──────────────────────────────────────────────────────────────────────────────┘
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ Low           │ Prototype Pollution                                          │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ minimist                                                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=0.2.1 <1.0.0 || >=1.2.3                                    │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ jest-coverage-badges [dev]                                   │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ jest-coverage-badges > mkdirp > minimist                     │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://npmjs.com/advisories/1179                            │
└───────────────┴──────────────────────────────────────────────────────────────┘
found 1 low severity vulnerability in 3 scanned packages

Impact 💣

Any projects using jest-coverage-badges are getting security warnings (and with NPM 7, non-zero exit codes) on npm install

Critical in: 2 MONTHS

Proposed solutions :squirrel:

Update mkdirp dependency to latest which no longer depends on the problematic minimist library

(if don't you have any solution in mind, write it)
This Tech debts still don't have any proposed issue.

(if you have solutions in mind, describe it below)
Solution 1.

• How

• Pros 💚

• Cons 💔

Observations 🤔

Files related

files related

Other evidences

Depends on issue X

test

Tech Debt Title

Summary

TL;DR: A simple summary about the tech debt
Age: { LEGACY | NEW_TECH_DEBT_INTRODUCED }

Estimated cost: { SIMPLE | COMPLEX | INVESTIGATION_NEEDED }

Description 📋

A clear and concise description of what the tech debt is and the reason of being created

Impact 💣

Description of the current or possible impact of this tech debt.

Critical in: { N MONTHS | N YEARS | UNKOWN }

Proposed solutions :squirrel:

How would you fix it?

(if don't you have any solution in mind, write it)
This Tech debts still don't have any proposed issue.

(if you have solutions in mind, describe it below)
Solution 1.

• How

• Pros 💚

• Cons 💔

Observations 🤔

Files related

files related

Other evidences

Depends on issue X

ENOENT: No such file coverage-summary.json

Hi

I set it up exactly as explained in master's README but it fails with below error. Using Jest v26.0.1:

Error: ENOENT: no such file or directory, open './coverage/coverage-summary.json'
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] test:badges: `npm run test:coverage && jest-coverage-badges`
npm ERR! Exit status 1

Thanks

Doesn't work with proxy servers

Since this package relies on the native Node https, it fails to function from behind a firewall that requires HTTPS traffic to go out over a proxy server.

When summary has non numeric "pct", the output is "Unknown%"

When summary has "pct": "Unknown" the output is "Unknown%", should be 0%

Please update dependency mkdirp

Hello @pamepeixinho

Can you please update the dependency mkdirp?
Currently you are referencing [email protected] and [email protected] has long been depreciated.

This is not a trivial request. An outdated mkdirp is causing problems in my work (I can't explain it all within a short piece of text).
But I would really appreciate it if you update the mkdirp dependency to a more updated version. I see now the current version of mkdirp is 1.0.4

Thank you