UNPKG

1.51 kBMarkdownView Raw
1# yarn-audit-html
2
3![](https://img.shields.io/david/davityavryan/yarn-audit-html.svg?style=flat-square)
4![](https://img.shields.io/david/dev/davityavryan/yarn-audit-html.svg?style=flat-square)
5![](https://img.shields.io/david/peer/davityavryan/yarn-audit-html.svg?style=flat-square)
6![](https://img.shields.io/github/last-commit/davityavryan/yarn-audit-html.svg?style=flat-square)
7![](https://img.shields.io/snyk/vulnerabilities/npm/yarn-audit-html.svg?style=flat-square)
8[![](https://img.shields.io/lgtm/alerts/g/davityavryan/yarn-audit-html.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/davityavryan/yarn-audit-html/alerts/)
9[![](https://flat.badgen.net/packagephobia/install/yarn-audit-html)](https://packagephobia.now.sh/result?p=yarn-audit-html)
10
11## Generate a HTML report for Yarn Audit
12
13## Install
14
15```
16$ yarn global add yarn-audit-html
17```
18
19> This package uses async/await and requires Node.js 7.6
20
21## Usage
22
23To generate a report, run the following:
24
25```
26$ yarn audit --json | yarn-audit-html
27```
28
29By default the report will be saved to `yarn-audit.html`
30
31If you want to specify the output file, add the `--output` option:
32
33```bash
34yarn audit --json | yarn-audit-html --output report.html
35```
36
37Unique vulnerability list will be generated by default. If you want to show all, one-by-one, add the `--no-unique` option:
38
39```bash
40yarn audit --json | yarn-audit-html --no-unique
41```
42
43Inspired by [npm-audit-html](https://github.com/Filiosoft/npm-audit-html) package.
44
45## License
46
47[MIT](LICENSE.md)