Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryym/node-depcop
Validate 'dependencies' and 'devDependencies' in your package.json
https://github.com/ryym/node-depcop
Last synced: 6 days ago
JSON representation
Validate 'dependencies' and 'devDependencies' in your package.json
- Host: GitHub
- URL: https://github.com/ryym/node-depcop
- Owner: ryym
- License: mit
- Created: 2016-02-23T14:44:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T14:45:34.000Z (12 months ago)
- Last Synced: 2025-01-14T19:29:19.593Z (8 days ago)
- Language: JavaScript
- Homepage:
- Size: 174 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Depcop - Validate dependencies in package.json
[][npm-version]
[][travis-ci]
[][appveyor]
[][coveralls]
[][david]
[][david-dev]
[](/LICENSE)
[](/docs)
[npm-version]: https://www.npmjs.org/package/depcop
[travis-ci]: https://travis-ci.org/ryym/node-depcop
[appveyor]: https://ci.appveyor.com/project/ryym/node-depcop/branch/master
[coveralls]: https://coveralls.io/github/ryym/node-depcop?branch=master
[david]: https://david-dm.org/ryym/node-depcop
[david-dev]: https://david-dm.org/ryym/node-depcop#info=devDependencies
Depcop is a tool to validate your `dependencies` and `devDependencies` in a `package.json`.
It checks your source code and warns if some dependency definitions are missing,
unused, or listed in a wrong group.
## Validations
### [Missing module check]
Makes sure:
* all modules used in source code are listed in `dependencies` or `devDependencies`
### [Unused module check]
Makes sure:
* `dependencies` and `devDependencies` don't contain modules used in any source
### [Strayed module check]
Makes sure:
* `dependencies` don't contain modules used only in development code
* `devDependencies` don't contain modules used in library code
#### Note: definition of terms
| term | description |
|:-----|:------------|
| library code | Ordinary source files usually put in `./lib`. |
| development code | Test files, config files, or build scripts like `gulpfile.js`. |
For more details about validations, please see [Validations].
## Features
* ES2015 style support (`import` declarations)
* CommonJS style support (`require` expressions)
* Configurable
## Installation
You can install Depcop using npm.
```
npm install --save-dev depcop
```
## Usage
You can use Depcop via [CLI] or [Node.js API].
Please see [Usage] for details.
```sh
# CLI
depcop --missing --unused -l 'lib/**/*.js' -d 'test/**/*.js','gulpfile.js'
```
```js
// JS
import { makeDepcop } from 'depcop';
const depcop = makeDepcop({
options: {
libSources: ['lib/**/*.js'],
devSources: ['test/**/*-test.js'],
checks: {
unused: {
ignore: ['istanbul', 'mocha']
}
}
}
});
const result = depcop.runValidations();
// ..
```
## Configuration
You can write a configuration file to configure Depcop.
Please see [Configuring Depcop] for details.
```js
// .depcoprc.js
module.exports = {
libSources: [
'lib/**/*.js'
],
devSources: [
'test/**/*-test.js',
'gulpfile.babel.js'
],
checks: {
missing: {
ignore: [/alias.+/]
},
unused: {}
}
};
```
## Why?
It is usually difficult to notice that some dependency definitions are missing (or unused)
in local environment where necessary dependencies have been installed. Especially, it is
so difficult to notice when you accidentally define a module in `devDependencies` which is
actually used in library code. In this case, all tests will pass in both of local and CI environment
where `devDependencies` will be installed.
And it is not until the module is installed to user environments where
`devDependencies` doesn't be installed that it causes an error for lack of dependencies.
The goal of this module is to prevent such a tragedy.
## Similar projects
* [dependency-check] - A CLI tool to check missing or unused dependencies.
* [require-lint] - A CLI tool which also supports [CoffeeScript].
* [eslint-plugin-node] - A ESLint plugin for Node.js. Linting dependencies is one of its features.
[Missing module check]: /docs/validations.md#missing-module-check
[Unused module check]: /docs/validations.md#unused-module-check
[Strayed module check]: /docs/validations.md#strayed-module-check
[Validations]: /docs/validations.md
[Usage]: /docs/usage.md
[CLI]: /docs/usage.md#command-line-interface
[Node.js API]: /docs/usage.md#nodejs-api
[Configuring Depcop]: /docs/configuration.md
[eslint-plugin-node]: https://github.com/mysticatea/eslint-plugin-node
[dependency-check]: https://github.com/maxogden/dependency-check
[require-lint]: https://github.com/TabDigital/require-lint
[CoffeeScript]: http://coffeescript.org/