mirror of
https://github.com/nodejs/node.git
synced 2025-05-17 20:06:54 +00:00
db54b57042
PR-URL: https://github.com/nodejs/node/pull/34468 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> |
||
|---|---|---|
| .. | ||
| lib | ||
| reporters | ||
| CHANGELOG.md | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
npm audit security report
Given a response from the npm security api, render it into a variety of security reports
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 |