https://github.com/eventonehq/npm-audit-html

🔒 Generate a HTML report for NPM Audit
https://github.com/eventonehq/npm-audit-html

hacktoberfest html npm npm-audit reporter security

Last synced: about 7 hours ago
JSON representation

🔒 Generate a HTML report for NPM Audit

• Host: GitHub
• URL: https://github.com/eventonehq/npm-audit-html
• Owner: eventOneHQ
• License: mit
• Created: 2018-06-14T20:09:45.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T18:51:31.000Z (about 2 years ago)
• Last Synced: 2025-01-16T12:32:22.268Z (7 days ago)
• Topics: hacktoberfest, html, npm, npm-audit, reporter, security
• Language: Handlebars
• Homepage: http://oss.eventone.page/npm-audit-html/
• Size: 1.38 MB
• Stars: 52
• Watchers: 2
• Forks: 26
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
npm-audit-html


















Generate a HTML report for NPM Audit


## 📝 Table of Contents

- [Getting Started](#getting_started)

- [Usage](#usage)

- [Contributing](CONTRIBUTING.md)

- [Authors](#authors)

- [Acknowledgments](#acknowledgement)

## 🏁 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:

```bash

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: 

```bash

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:

```bash

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

```

## ✍️ Authors 

- [@nprail](https://github.com/nprail) - Maintainer

See also the list of [contributors](https://github.com/eventOneHQ/npm-audit-html/contributors) who participated in this project.

## 🎉 Acknowledgements 

- Hat tip to anyone whose code was used

## License

[MIT](LICENSE)