UNPKG

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