Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Build Status Code Climate Gem Version

npmdc

Screenshot

NPM Dependency Checker is a simple tool which can check for missed dependencies based on your package.json file.

Sponsored by Evil Martians

Installation

Add this line to your application's Gemfile:

gem 'npmdc', group: :development

And then execute:

$ bundle

Or install it yourself as:

$ gem install npmdc

Usage

Rails

YourApp::Application.configure do
  config.npmdc.path             = "/path/to/your/frontend/code/dir" # `Rails.root` by default
  config.npmdc.format           = "doc"                             # `short`, `doc`, `progress`. `short` by default
  config.npmdc.color            = false                             # `true` by default
  config.npmdc.types            = ["dependencies"]                  # `["dependencies", "devDependencies"]` by default
  config.npmdc.environments     = ["development"]                   # `development` only by default
  config.npmdc.abort_on_failure = true                              # 'false' by default
end

CLI tool:

$ bundle exec npmdc [options]

Options:

      [--path=PATH]            # Path to package.json config
      [--color], [--no-color]  # Enable color
                               # Default: true
  t, [--types=one two three]   # types for check
                               # Default: ["dependencies", "devDependencies"]
                               # Possible values: dependencies, devDependencies
  f, [--format=FORMAT]         # Output format
                               # Possible values: progress, doc, short

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lysyi3m/npmdc.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.