dep-validate
dep-validate is a tool used to verify the ranges on your npm dependencies. It can be used from the command line, from JavaScript, or from Gulp. It's available on npm, so just install it via:
# for gulp/node usage
$ npm install --save-dev dep-validate
# for command line usage
$ npm install -g dep-validate
Command Line Usage
Super easy, it's just the same interface as the JavaScript library (read up).
$ dep-validate --dependencies '~' --devDependencies '^' --exclude pkg1 --exclude pkg2 --hardcoded=allow --only production --only development --packageFile ./package.json
The exit code will be a 1
in case of error, with a chart displaying errors. It'll be 0
on success with no output.
Library Usages
You can use the JavaScript library either directly in Node.js or via Gulp:
JavaScript Interface
All options are shown below and are the defaults (so they're used if not provided). The only exception is file
, which will resolve the current package.json
(by reading upwards in directory).
var dv = ; // available optionsvar opts = dependencies: '~' // the range to enforce on all "dependencies" devDependencies: '^' // the range to enforce on all "devDependencies" exluded: 'my-package' // packages to exclude from validation hardcoded: 'allow|force' // allow or force hardcoded versions packageFile: './package.json' // the package.json file to read and validate only: 'production' 'development' // only check prod/dev dependencies // `validate()` results a results objectvar results = dv; // which can be printed using `log()`if dv dv; // or use `pipe()` for a callback-style interface (it's still synchronous)dv
Gulp
var dv = ;var gulp = ; gulp
In addition to the options accepted by the JavaScript interface, .gulp()
can also accept a failOnError
option which will cause your Gulp task to cause an error if your dependencies do not satisfy your rules.