Skip to content

larsgw/npm-audit-report

 
 

Repository files navigation

npm audit security report

Given a response from the npm security api, render it into a variety of security reports

Build Status Build status Coverage Status

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

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%