Giter VIP home page Giter VIP logo

npm-audit-report's Introduction

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

npm-audit-report's People

Contributors

evilpacket avatar zkat avatar iarna avatar mdix avatar larsgw avatar luislobo avatar phil-r avatar turbo87 avatar welwood08 avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.