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 file (or a file that transpiles to javascript)
• 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

Any options not set in the configuration file will be given there default value.

Options

• allowUnused
  • array of strings or regular expressions 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
• devFilePatterns
  • array of path patterns to match againt a filename to determine if it is used only for development (see minimatch)
  • default: ['{features,spec,test}/**/*', '**/*_{spec,test}.js']
• devScripts
  • array of strings or regular expressions to match against a script name in your package.json to determine if it is used only for development
  • default: ['lint', 'publish', 'test']
• filePattern
  • path pattern to match against a filename to determine if it should be parsed (see https://github.com/isaacs/minimatch)
  • This is the starting point, devFilePatterns and ignoreFilePatterns should be subsets of this pattern
  • default: '**/*.js'
• ignoreFilePatterns
  • array of path patterns to match against a filename to determine if it should be ignored (see minimatch)
  • default: ['node_modules/**/*']
• stripLoaders
  • boolean whether to ignore anything before a ! in require statements - allows dependency-lint to be used with webpack
  • default: false
• transpilers
  • array of transpilers with the properties extension and module. The module will be required and then the compile property will be called with the file contents and the filename for each file with that extension
  • example: [{extension: '.coffee', module: 'coffee-script'}] would call require('coffee-script').compile(code, {filename: pathToFile}); for each file with a .coffee extension
  • default: []

Changelog

3.0.0 (2016-02-09)

• remove support for configuration files with extensions: cson, coffee, js, json, yaml
  • please convert to dependency-lint.yml
• remove built in support for coffee-script
• add transpilers configuration option
• add filePattern configuration option

---