npmpackage.info

Gathering detailed insights and metrics for better-npm-audit

Other packages similar to better-npm-audit

better-npm-audit-json

3.7.9

Reshape into a better npm audit for the community and encourage more people to include security audit into their process.

@chax-at/better-npm-audit

3.6.9

Reshape into a better npm audit for the community and encourage more people to include security audit into their process.

better-lerna-audit

1.0.0

Micro util to run better-npm-audit for lerna packages (with optional autofix)

Gathering detailed insights and metrics for better-npm-audit

better-npm-audit - 3.11.0 | npmpackage.info

better-npm-audit

The goal of this project is to provide additional features on top of the existing npm audit options

3.11.0

123

MIT

TypeScript

44.08 kB

13,186,192 4.1

Installations

npm install better-npm-audit

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>= 8.12

Node Version

22.6.0

NPM Version

10.8.2 Score

96.9

Supply Chain

81.2

Quality

80.1

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

5

Total

49

Closed

9

Merged

35

Issues

Open

12

Total

43

Closed

31

Releases

v3.11.0

Updated on Sep 09, 2024

v3.10.0

Updated on Sep 03, 2024

v3.9.0

Updated on Sep 02, 2024

v3.8.3

Updated on Aug 17, 2024

Use "--omit=dev" internally on newer npm version

3.8.0

Updated on Aug 17, 2024

Added handling for empty strings in displaying unused exception message

v3.7.3

Updated on Mar 21, 2022

View All 17 releases

Languages

TypeScript

JavaScript

TypeScript (98.67%)

JavaScript (1.33%)

Developer

jeemok

Download Statistics

Total Downloads

13,186,192

Last Day

16,529

Last Week

94,154

Last Month

414,024

Last Year

4,581,181

GitHub Statistics

MIT License

123 Stars

268 Commits

26 Forks

4 Watchers

2 Branches

12 Contributors

Updated on Feb 28, 2025

Bundle Size

165.26 kB

Minified

44.08 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 12 Contributors

Package Meta Information

Latest Version

3.11.0

Package Id

better-npm-audit@3.11.0

Unpacked Size

44.46 kB

Size

11.49 kB

File Count

NPM Version

10.8.2

Node Version

22.6.0

Published on

Sep 09, 2024

Total Downloads

Cumulative downloads

Total Downloads

13,186,192

Better NPM Audit

The goal of this project is to provide additional features on top of the existing npm audit options. We hope to encourage more people to do security audits for their projects.

npm downloads node current GitHub issues npm bundle size Languages

Looking for Collaborators

Hi there! 👋

I’m currently looking for collaborators to help maintain and develop this project. Due to time constraints, I haven’t been able to give it the attention it deserves, but I believe it has great potential to grow with the help of passionate contributors.

Become a Collaborator If you’re interested in contributing on a regular basis, I’d love to have you on board as a collaborator. Whether you’re interested in fixing bugs, adding new features, or improving documentation, your contributions will be highly valued.

As a collaborator, you’ll have push access to the repository and play a key role in shaping the future of the project. If this sounds like something you’d be interested in, please reach out! You can open an issue titled “Interested in Collaborating” or contact me directly via email.

Let’s work together to make this project even better!

NPM version 6 and 7, and 8

NPM has upgraded to version 7 in late 2020 and has breaking changes on the npm audit. The output of npm audit has significantly changed both in the human-readable and --json output styles. Even more unfortunately, when NPM changed the JSON output in npm v7, they removed many of the other useful identifiers (cves, cwe, github_advisory_id) and the only thing left is the URL. We are trying our best to handle each version and provide consistent functionality to all of them. Related docs on v6 and v7 changes:

Docs	Link
NPM v6 & v7 changes	https://github.blog/2020-10-13-presenting-v7-0-0-of-the-npm-cli/
NPM v7 blog post	https://blog.npmjs.org/post/626173315965468672/npm-v7-series-beta-release-and-semver-major
Official NPM v6 audit docs	https://docs.npmjs.com/cli/v6/commands/npm-audit
Official NPM v7 audit docs	https://docs.npmjs.com/cli/v7/commands/npm-audit
Dealing with new npm audit	https://uko.codes/dealing-with-npm-v7-audit-changes

You may find the sample JSON outputs for each NPM versions in our codebase: v6, v7 & v8.

Installation

$ npm install --save better-npm-audit

$ npm install -g better-npm-audit

Usage

Run global

1better-npm-audit audit

Run with exceptions

Demo of table displaying the security report

Unhandled or newly reported vulnerabilities will be highlighted:

Unused exceptions will be notified:

Add into package scripts

1{
2  "scripts": {
3    "prepush": "npm run test && npm run audit",
4    "audit": "better-npm-audit audit"
5  }
6}

Now you can run locally or in your CI pipeline:

1npm run audit

Options

Flag	Short	Description
`--exclude`	`-x`	Exceptions or the vulnerabilities ID(s) to exclude; the ID can be the numeric ID, CVE, CWE or GHSA ID
`--module-ignore`	`-m`	Names of modules to exclude
`--level`	`-l`	The minimum audit level to validate; Same as the original `--audit-level` flag
`--production`	`-p`	Skip the `devDependencies`
`--registry`	`-r`	The npm registry url to use
`--include-columns`	`-i`	Columns to include in report

Environment Variables

Variable	Description
`NO_COLOR`	Support the no-color standard to allow users use the tool without colored output.
`NPM_CONFIG_AUDIT_LEVEL`	Used in setting the audit level. Note: this will be disregard if the audit level flag is passed onto the command.

Using `.nsprc` file to manage exceptions

You may add a file .nsprc to your project root directory to manage the exceptions. For example:

1{
2  "1337": {
3    "active": true,
4    "notes": "Ignored since we don't use xxx method",
5    "expiry": 1615462134681
6  },
7  "4501": {
8    "active": false,
9    "notes": "Ignored since we don't use xxx method"
10  },
11  "CWE-471": "CWE ID is acceptable",
12  "GHSA-ww39-953v-wcq6": "GHSA ID is acceptable",
13  "https://npmjs.com/advisories/1213": "Full or partial URL is acceptable too"
14}

Fields

Attribute	Type	Description	Default	Examples
`active`	Boolean	If the tool should use it for exception	`true`	`true`
`expiry`	String \| Number	Human-readable date, or milliseconds since the UNIX Epoch		- `'2020-01-31'` - `'2020/01/31'` - `'01/31/2021, 11:03:58'` - `'1 March 2016 15:00'` - `'1 March 2016 3:00 pm'` - `'2012-01-26T13:51:50.417-07:00'` - `'Sun, 11 Jul 2021 03:03:13 GMT'` - `'Thu Jan 26 2017 11:00:00 GMT+1100 (Australian Eastern Daylight Time)'` - `327611110417`
`notes`	String	Notes related to the vulnerability.

When using a .nsprc file, a report will be displayed when it starts running:

Demo of table displaying a list of exceptions

Note: the expiry date will be styled in yellow and red color if it is detected more than one or five years ago.

Changelog

You can find the changelog here.

Contributors

Ian Wright, Edwin Taylor, Maarten Hus, Alex Burkowsky, David M. Lee, Kyle Clark, Guillermo Pincay, Grzegorz Pawłowski, CSLTech, Paul Clarkin, mgdodge, Ricky Sullivan, Sam Gregory, Tristan WAGNER, Zak, Eric Cornelissen, Gaurav Chinavle

If you like this project,

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

7

SAST

Determines if the project uses static code analysis.

3

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

4.1

/10

Last Scanned on 2025-05-05

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

Other packages similar to better-npm-audit

Other packages similar to better-npm-audit

better-npm-audit

Installations

Developer Guide

No

CommonJS

>= 8.12

22.6.0

10.8.2

Score

Pull Requests

5

49

9

35

Issues

12

43

31

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

165.26 kB

44.08 kB

Maintainers

Package Meta Information

Total Downloads

13,186,192

Dependencies

Dev Dependencies

Better NPM Audit

Looking for Collaborators

NPM version 6 and 7, and 8

Installation

Usage

Run global

Run with exceptions

Add into package scripts

Options

Environment Variables

Using .nsprc file to manage exceptions

Fields

Changelog

Contributors

10

10

10

8

7

3

1

1

0

0

0

0

0

4.1

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads

Using `.nsprc` file to manage exceptions