Skip to content
This repository has been archived by the owner on Feb 2, 2022. It is now read-only.

improvement: report output readability #40

Merged
merged 8 commits into from
Jul 18, 2019

Conversation

shockey
Copy link
Contributor

@shockey shockey commented Jul 12, 2019

This PR introduces a table report format, and makes the report messaging more helpful by repeating back the selected options to the user.

Context

I'm integrating npm-audit-ci-wrapper in Swagger UI.

This is the only module with the right combination of options for our purposes, but I found that vulnerability readouts were overflowing my (relatively-narrow) terminal window, and the static message coming back from the utility wasn't helpful in differentiating between the two runs we want to do for our audits.

Before

image

After

image

@shockey shockey marked this pull request as ready for review July 12, 2019 00:53
@shockey
Copy link
Contributor Author

shockey commented Jul 12, 2019

FWIW, it might also be worthwhile to discuss copying npm's table style:

image

...or at least including equivalent information -- I find the dependency path trace to be helpful.

Copy link
Owner

@InfoSec812 InfoSec812 left a comment

Choose a reason for hiding this comment

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

I'll try to take a look in an hour or so. Thanks for the contribution!

@shockey
Copy link
Contributor Author

shockey commented Jul 18, 2019

@InfoSec812 bump!

@InfoSec812
Copy link
Owner

@InfoSec812 bump!

Sorry, I haven't had a chance to test it out and confirm. I will try to do that this morning.

@InfoSec812
Copy link
Owner

I tested it on a few projects and I am OK with this. One of the main concerns I has was to ensure it didn't break the JSON output option so that it could be piped to npm-audit-html and that still works. APPROVED!

@InfoSec812
Copy link
Owner

InfoSec812 commented Jul 18, 2019

@shockey One last thing... Please bump the version in package.json and then I will merge.

@InfoSec812 InfoSec812 merged commit e3231f6 into InfoSec812:master Jul 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants