Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: described exit codes in npm-audit docs #135

Closed

Conversation

emilis-tm
Copy link
Contributor

Background

It was very easy to just append npm audit to my npm test script, because it returns a correct exit status when vulnerabilities are found.

I think the doc page (https://docs.npmjs.com/cli/audit) should tell readers about the exit status. Had to run my own mini-experiment to see if it works the way I expected.

Change

  • I added a sentence about the exit status to the description block.
  • I added a section with further description to the page:
    • below CONTENT SUBMITTED, because of the order in the DESCRIPTION paragraph,
    • felt the need to mention audit-level configuration setting.

Copy link
Contributor

@zkat zkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good! I'd appreciate it if you could rebase this onto latest. You seem to have slurped up a stray commit. I'm otherwise good with merging this 👍

@zkat zkat removed the in-progress label Feb 18, 2019
@zkat zkat changed the base branch from latest to release-next February 18, 2019 22:40
zkat pushed a commit that referenced this pull request Feb 18, 2019
@zkat
Copy link
Contributor

zkat commented Feb 18, 2019

Merged this one by hand. :) Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants