https://github.com/hsz/webpack-nodesecurity-plugin

Run Node Security check on your package.json file using Webpack
https://github.com/hsz/webpack-nodesecurity-plugin

javascript node-security nodejs npm security webpack

Last synced: 2 months ago
JSON representation

Run Node Security check on your package.json file using Webpack

• Host: GitHub
• URL: https://github.com/hsz/webpack-nodesecurity-plugin
• Owner: hsz
• Created: 2018-01-22T08:21:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-29T08:24:21.000Z (over 6 years ago)
• Last Synced: 2024-09-30T13:41:27.748Z (3 months ago)
• Topics: javascript, node-security, nodejs, npm, security, webpack
• Language: JavaScript
• Homepage:
• Size: 43.9 KB
• Stars: 23
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Webpack Node Security Plugin

Webpack plugin that runs the Node Security Platform audit on your package.json, package-lock.json or npm-shrinkwrap.json.

> NOTE: Webpack plugin is a wrapper for the [nodesecurity/nsp](https://github.com/nodesecurity/nsp) package.

## Install

```bash

npm install --save-dev webpack-nodesecurity-plugin

```

## Usage

In your `webpack.config.js`

```javascript

var NodeSecurityPlugin = require('webpack-nodesecurity-plugin');

module.exports = {

    // ...

    plugins: [

      new NodeSecurityPlugin()

    ]

};

```

## Options:

```js

module.exports = {

    // ...

  plugins: [

    new NodeSecurityPlugin(options)

  ]

}

```

### `options.reporter`

Type: `String`


Default: `summary`

Defines the output format of the vulnerabilities report. Available (built-in) reporters:

- table

- summary

- json

- codeclimate

- minimal

It is possible to install 3rd party reporters from npm or create your own one.

For more information, go to [nodesecurity/nsp#output-reporters](https://github.com/nodesecurity/nsp#output-reporters)

### `options.verbose`

Type: `Boolean`


Default: `false`

Provide more verbose output.

### `options.quiet`

Type: `Boolean`


Default: `false`

## License

MIT © [Jakub hsz Chrzanowski](https://github.com/hsz)