# npm-audit-html

> Generate a HTML report for NPM Audit

Latest version **1.5.0** (published 2020-11-11) · MIT license · 16.2K weekly downloads

## Install

```sh
npm install npm-audit-html
pnpm add npm-audit-html
yarn add npm-audit-html
bun add npm-audit-html
```

Provides the command `npm-audit-html`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2020-11-11 |
| First published | 2018-06-14 |
| Weekly downloads | 16.2K |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 27.6 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 53 |
| Author | eventOne Labs |
| Maintainers | nprail |

## Links

- npm: https://www.npmjs.com/package/npm-audit-html
- Repository: https://github.com/eventOneHQ/npm-audit-html
- Homepage: https://github.com/eventOneHQ/npm-audit-html#readme
- Issues: https://github.com/eventOneHQ/npm-audit-html/issues
- npm.io page: https://npm.io/package/npm-audit-html

## Dependencies (11)

- [open](https://npm.io/package/open.md) ^7.3.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [marked](https://npm.io/package/marked.md) ^1.2.2
- [moment](https://npm.io/package/moment.md) ^2.29.1
- [numeral](https://npm.io/package/numeral.md) ^2.0.6
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.6
- [highlight.js](https://npm.io/package/highlight.js.md) ^10.3.1
- [terminal-link](https://npm.io/package/terminal-link.md) ^2.1.1
- [update-notifier](https://npm.io/package/update-notifier.md) ^4.1.3

## Recent versions

- 1.5.0 (latest) — 2020-11-11
- 2.0.0-beta.2 (beta) — 2022-01-28
- 2.0.0-beta.1 — 2021-10-11
- 1.4.3 — 2020-08-05
- 1.4.2 — 2020-08-05
- 1.4.1 — 2020-04-16
- 1.4.0 — 2019-11-10
- 1.3.4 — 2019-08-27
- 1.3.3 — 2019-07-26
- 1.3.2 — 2019-04-26
- 1.3.1 — 2019-02-25
- 1.3.0 — 2019-02-25
- 1.2.0 — 2018-12-15
- 1.1.0 — 2018-06-14
- 1.0.0 — 2018-06-14

## README

<h1 align="center">npm-audit-html</h1>

<p align="center">
<a href="https://github.com/eventOneHQ/npm-audit-html/blob/master/LICENSE"><img src="https://img.shields.io/github/license/eventOneHQ/npm-audit-html.svg" alt="GitHub license"></a>
<a href="https://www.npmjs.com/package/npm-audit-html"><img src="https://img.shields.io/npm/v/npm-audit-html.svg" alt="npm"></a>
<a href="https://travis-ci.com/eventOneHQ/npm-audit-html"><img src="https://travis-ci.com/eventOneHQ/npm-audit-html.svg?branch=master" alt="Build Status"></a>
<a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly"></a>
<a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a>
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>

</p>
<p align="center"><b>Generate a HTML report for NPM Audit</b></p>

## 📝 Table of Contents

- [Getting Started](#getting_started)
- [Usage](#usage)
- [Contributing](CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)

## 🏁 Getting Started <a name = "getting_started"></a>

```
$ npm install -g npm-audit-html
```

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

## 🎈 Usage <a name="usage"></a>

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 <a name = "authors"></a>

- [@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 <a name = "acknowledgement"></a>

- Hat tip to anyone whose code was used

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/npm-audit-html · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._