Skip to content

eventOneHQ/npm-audit-html

Repository files navigation

npm-audit-html

GitHub license npm Build Status Commitizen friendly JavaScript Style Guide semantic-release

Generate a HTML report for NPM Audit

πŸ“ Table of Contents

🏁 Getting Started

$ npm install -g npm-audit-html

This package uses async/await and requires Node.js 7.6

🎈 Usage

To generate a report, run the following:

$ npm audit --json | npm-audit-html

By default the report will be saved to npm-audit.html

If you want to specify the output file, add the --output option:

npm audit --json | npm-audit-html --output report.html

You can also fully customize the generated report by providing --template option followed by your own handlebars template:

npm audit --json | npm-audit-html --template ./my-awesome-template.hbs

If you'd like the generator to exit with non-zero exit code when vulnerabilities are found, you can add the --fatal-exit-code option:

npm audit --json | npm-audit-html --fatal-exit-code

✍️ Authors

See also the list of contributors who participated in this project.

πŸŽ‰ Acknowledgements

  • Hat tip to anyone whose code was used

License

MIT