Publish your own packages to the world's most popular software ecosystem with npm Pro.Get started »

lint-deps

3.0.2 • Public • Published

lint-deps NPM version

CLI tool that tells you when dependencies are missing from package.json and offers you a choice to install them. Also tells you when dependencies are listed in package.json but are not being used anywhere in your project. Node.js command line tool and API.

Install

Install globally with npm

$ npm i -g lint-deps

CLI

In the command line, run:

deps

Commands

  • -r | --report: save a report to disk. By default report.json is saved. To change the path do: -r foo.json
  • -e | --exclude: comma-separated list of files or directories to exclude. Example: deps -e test,lib

Examples

If everything is good, you'll see something like this:

image

Install missing packages

If packages are missing, you'll see a prompt like this (also shows which files require the package):

image

If you choose yes:

image

choose dependencies

Works the same way for devDependencies:

image

choose "nothing, just install"

image

Now hit enter and everything that was checked will be installed.

If you choose no:

image

Done.

API

var deps = require('lint-deps');
 
// pass the directory to scan
console.log(deps('lib'));

Manually define dependencies

When dependencies are defined in a format that isn't recognized by lint-deps, like with grunt tasks (e.g. grunt.loadNpmTasks()), you can manually specify these dependencies in code comments, similar to jshint commands.

Example:

Make sure deps is the first thing, and pass a space separated list of module names:

/** deps: foo bar baz */

If you use verb, you can use HTML code comments in your .verb.md file:

{%= reflinks() %}
<!-- deps: helper-reflinks -->

Related projects

  • list-deps: List the dependencies in the package.json of the current project. | homepage
  • lookup-deps: Simple API for getting metadata from locally installed npm packages (in node_modules). | homepage
  • resolve-dep: Return an array of resolved filepaths for require-able local or named npm modules. Wildcard (glob)… more | homepage
  • spawn-commands: Launches a new process with the given command, with command line arguments in args. Should… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on November 17, 2015.

Install

npm i lint-deps

DownloadsWeekly Downloads

1

Version

3.0.2

License

MIT

Last publish

Collaborators

  • avatar
  • avatar