https://github.com/raphamorim/ranza
The dependency checker
https://github.com/raphamorim/ranza
Last synced: about 1 year ago
JSON representation
The dependency checker
- Host: GitHub
- URL: https://github.com/raphamorim/ranza
- Owner: raphamorim
- Created: 2015-03-18T01:50:10.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-18T04:03:27.000Z (almost 11 years ago)
- Last Synced: 2025-02-26T02:17:50.083Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/ranza
- Size: 938 KB
- Stars: 30
- Watchers: 4
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Ranza
> The dependency checker
[](https://www.npmjs.org/package/ranza)
[](https://travis-ci.org/raphamorim/ranza)
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](http://nodejs.org/) and [npm](https://www.npmjs.org/) installed, install ranza with a single command.
##### As CLI
```sh
$ npm install -g ranza
```
##### As Node Module
```sh
$ npm install ranza
```
## CLI Usage
#### Status
Checks all project for required dependencies and confirms if they are listed on `package.json`:
```sh
$ ranza status
```
You can use status with debug option as arguments, to best view requires status showing the occurrence files, ex:
**input:**
```sh
$ ranza status --debug
```
**some output example:**
```sh
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`:
```sh
$ ranza install
```
Installs all dependencies required throughout the project and add them to `package.json` as `dependencies`:
```sh
$ ranza install --save
```
Installs all dependencies required throughout the project and save them in `package.json` as `devDependencies`:
```sh
$ ranza install --save-dev
```
#### Clean
Remove and clean all unused dependencies from `package.json`:
```sh
$ ranza clean
```
## Node Module Usage
### Status
You can check the dependencies status from current project using:
```javascript
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:
```javascript
var ranza = require('ranza');
ranza.check('file.js', function(dependencies, err) {
console.log(dependencies) // ['kenobi', 'bluebird']
console.log(err) // null
});
```
## History
See [Changelog](docs/changelog.md) 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](https://github.com/raphamorim)