blob: 1d1697f4f5205c033cc6f6c54d313af2c4d4dde2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
# npm audit security report
Given a response from the npm security api, render it into a variety of security reports
[](https://travis-ci.org/npm/npm-audit-report)
[](https://ci.appveyor.com/project/evilpacket/npm-audit-report/branch/master)
[](https://coveralls.io/github/npm/npm-audit-report?branch=master)
The response is an object that contains an output string (the report) and a suggested exitCode.
```
{
report: 'string that contains the security report',
exit: 1
}
```
## Basic usage example
```
'use strict'
const Report = require('npm-audit-report')
const options = {
reporter: 'json'
}
Report(response, options, (result) => {
console.log(result.report)
process.exitCode = result.exitCode
})
```
## options
| option | values | default | description |
| :--- | :--- | :--- |:--- |
| reporter | `install`, `detail`, `json`, `quiet` | `install` | specify which output format you want to use |
| withColor | `true`, `false` | `true` | indicates if some report elements should use colors |
| withUnicode | `true`, `false` | `true` | indicates if unicode characters should be used|
|
