Awesome

Ranza

The dependency checker

Quickly spot any dependency required in the project and not listed in package.json. And also the other way around: quickly remove listed dependencies that are not being used.

Supports ES5 / ES6

Why use ranza?

Avoid accumulation of dependencies that are not being used.

Getting Started

With node and npm installed, install ranza with a single command.

As CLI

$ npm install -g ranza

As Node Module

$ npm install ranza

CLI Usage

Status

Checks all project for required dependencies and confirms if they are listed on package.json:

$ ranza status

You can use status with debug option as arguments, to best view requires status showing the occurrence files, ex:

input:

$ ranza status --debug

some output example:

Defined and used:
  • babel-core
     => lib/new.js

  • bluebird
     => core/src/comparer.js
     => core/src/manager.js
     => core/src/sentinel.js

Defined, but unused:
  • grunt
  • babel

Install

Installs all dependencies required throughout the project, but do not save them in package.json:

$ ranza install

Installs all dependencies required throughout the project and add them to package.json as dependencies:

$ ranza install --save

Installs all dependencies required throughout the project and save them in package.json as devDependencies:

$ ranza install --save-dev

Clean

Remove and clean all unused dependencies from package.json:

$ ranza clean

Node Module Usage

Status

You can check the dependencies status from current project using:

var ranza = require('ranza');

ranza.status(function(status) {
	/* 
	status = { 
		undefinedUsed: [], 
		definedUnused: [ 'ejs'], 
		definedUsed: [ 'express', 'kenobi' ] 
	}
	*/

	console.log(status)
});

Check

Return dependencies (require and import) from current file using:

var ranza = require('ranza');

ranza.check('file.js', function(dependencies, err) {
    console.log(dependencies) // ['kenobi', 'bluebird']
    console.log(err) // null
});

History

See Changelog for more details.

Contributing

Don't be shy, send a Pull Request! Here is how:

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

About

License: MIT ® Raphael Amorim