Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/junosuarez/sanitycheck
node module: ensure that all deps are present and accounted for CI / CD
https://github.com/junosuarez/sanitycheck
Last synced: 8 days ago
JSON representation
node module: ensure that all deps are present and accounted for CI / CD
- Host: GitHub
- URL: https://github.com/junosuarez/sanitycheck
- Owner: junosuarez
- License: isc
- Created: 2014-06-12T20:24:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-10T19:00:58.000Z (over 9 years ago)
- Last Synced: 2024-11-01T08:01:01.657Z (14 days ago)
- Language: JavaScript
- Size: 146 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sanitycheck
ensure that all deps are present and accounted for CI / CD
[](https://github.com/feross/standard)
## usage
add it as a dev dependency to your project
```console
$ npm install --save-dev sanitycheck
```
and add it to your test command by editing your `package.json`:
```javscript
{
"scripts": {
"test": "sanitycheck && "
}
}
```
Now you can run it using `$ npm test` and add it to your favorite testing or CI scripts.
If there are any errors, it exits with an error code of 1. As of 2.0.0, dependencies found
in package.json but not used in code count as errors.
## example output:
### ok
```console
Checking for unused or missing dependencies in package.json...
Validating all require statements...
···
OK
```
### missing dependencies
```console
Checking for unused or missing dependencies in package.json...
Dependencies missing in package.json: cool-ascii-faces
```
### depenency case error
```console
Checking for unused or missing dependencies in package.json...
Validating all require statements...
·☹ ·
1 Errors:
Error: Inside "c:\dev\sanitycheck\index.js"
Cannot resolve "./SUB" because:
"c:\dev\sanitycheck\SUB.js" doesn't exactly match the actual file path
"c:\dev\sanitycheck\sub.js"
```
## kudos
makes use of excellent work from [@thlorenz](https://github.com/thlorenz) in [valiquire](https://npm.im/valiquire) and [@jutaz](https://github.com/jutaz) in [depscan](https://npm.im/depscan)
## contributors
- jden
## license
ISC. (c) MMXIV jden . See LICENSE.md