Skip to content

forthright/vile-nsp

Repository files navigation

vile-nsp Circle CI score-badge coverage-badge dependency-badge

A Vile plugin for tracking Node security alerts (via NSP's CLI).

Requirements

Installation

npm i -D vile vile-nsp

Config

You can specify a few things the nsp check method accepts.

Package

By default, package.json in the cwd is used.

You can also specify a custom path:

nsp:
  config:
    package: some/other/package.json

Shrinkwrap

Additionally, you can set the shrinkwrap path:

nsp:
  config:
    shrinkwrap: shrinkwrap.json

Offline Mode

nsp:
  config:
    offline: true
    advisories: "optional/path/to/advisories.json"

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

  1. Please consider tests and code quality before submitting.
  2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Maintainers

Architecture

  • src is es6+ syntax compiled with Babel
  • lib generated js library

Developing

cd vile-nsp
npm install
npm run dev
npm test