dependency-lint

dependency-lint

Lints your NPM dependencies and devDependencies reporting which node modules are

• missing and should be added to your dependencies or devDependencies
• unused and should be removed from your dependencies or devDependencies
• mislabeled and should be moved from dependencies to devDependencies or vice versa

Installation

npm install dependency-lint

Usage

On the command line:

dependency-lint

How it works

dependency-lint compares the node modules listed in your package.json and the node modules it determines are used. A node module is used if:

• it is required in a javascript or coffeescript file
• one of its executables is used in a script in your package.json

If you run into an example where dependency-lint marks a node module as unused, and you are using it, please create an issue describing the situation. As a short-term solution, configure dependency-lint to allow that node module to be unused.

Configuration

Create a configuration file with

dependency-lint --generate-config

Options

• allowUnused
  • array of strings to match against a module name to determine if it is allowed to be unused
  • default: []
  • Please create an issue anytime you need to use this
• devFiles
  • array of strings to match againt a filename to determine if it is used only for development
  • default: ["^(features|spec|test)/", "_(spec|test).(coffee|js)$"]
• devScripts
  • array of strings to match against a script name in your package.json to determine if it is used only for development
  • default: ["test", "publish"]
• ignoreFiles
  • array of strings to match against a filename to determine if it should be ignored
  • default: []
  • the node_modules folder is always ignored

Changelog

1.4.1 (2015-05-12)

• more informative message when modules are not installed

---