Track and lock down your dependency licenses.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
src
test
.babelrc
.editorconfig
.eslintignore
.eslintrc
.gitattributes
.gitignore
.vile.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
LICENSE
README.md
package-lock.json
package.json

README.md

vile-license

A Vile plugin for tracking and locking down your dependency licenses.

Supported Checks

Requirements

Installation

npm i -D vile vile-license

Config

You specify the license types you can have and can't have in your .vile.yml.

Whitelisting

license:
  config:
    allowed: MPL-2.0

or:

license:
  config:
    allowed:
      - MIT
      - MPL-2.0

Note: Strings are partially matched, so be explicit (ex MPL-2.0) and use both whitelisting and blacklisting if you want to be sure you don't have a false positive.

Blacklisting

license:
  config:
    disallowed:
      - Something

Ignoring

You can ignore specific packages as well.

license:
  config:
    ignored:
      - some-pkg

Restrictions

Assumes files are in the cwd.

Vile Types Generated

Generates vile.SEC for each license violation.

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-license
npm install
npm run dev
npm test