Audit documentation still has old output format
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 712
- Forks
- 4.2k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 3
Description
Documentation such as https://docs.npmjs.com/about-audit-reports and https://docs.npmjs.com/auditing-package-dependencies-for-security-vulnerabilities still shows and describes the table formatted output used in npm@6 but not in version 7+.
I was hoping to find documentation about the current output, since it is not as nicely formatted as the old table output and has some confusing aspects. For example, as far as I can tell, the "counts" seem count each package on the dependency path to the actually vulnerable package rather than just the number of vulnerabilities (https://github.com/npm/cli/issues/4272). I would love to have some official documentation explaining how to interpret this output.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the two npm audit documentation pages linked in the issue and compare their examples and descriptions with the npm@7+ output. Review npm/cli#4272 for the reported count behavior; done means the pages no longer describe the npm@6 table format and explain how to interpret the current output.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100