Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alveflo/contrabando
Scans node modules for contraband licenses
https://github.com/alveflo/contrabando
contraband-license license-scan node npm
Last synced: 14 days ago
JSON representation
Scans node modules for contraband licenses
- Host: GitHub
- URL: https://github.com/alveflo/contrabando
- Owner: alveflo
- License: mit
- Created: 2017-06-26T10:44:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-06-29T19:54:17.000Z (over 7 years ago)
- Last Synced: 2024-10-22T22:29:29.145Z (2 months ago)
- Topics: contraband-license, license-scan, node, npm
- Language: HTML
- Size: 128 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Contrabando
Scans node modules for contraband licenses
Ok now that's not entirely true. What it really does is that it compares the licenses of your dependencies against your own and redflags all licenses that differs. It also gives you a nice html output that you can use to manually see which dependencies your module has and also which licenses that are smuggled in there, which is quite handy in many cases.
## Install
```
$ npm install --global contrabando
```
## Usage
Navigate to your modules entry directory (location of `package.json`) and run
```
$ contrabando
```
Note that it's only the `dependencies` entries that are scanned, not peer/dev/optional/bundled dependencies.
### Example
##### Terminal output
```
> Scanning module 'contrabando'...
┌─────────────┬────────────────────────┬─────────┐
│ Module │ User(s) │ License │
├─────────────┼────────────────────────┼─────────┤
│ cli-table │ contrabando │ Unknown │
├─────────────┼────────────────────────┼─────────┤
│ colors │ cli-table, contrabando │ MIT │
├─────────────┼────────────────────────┼─────────┤
│ jsonfile │ contrabando │ MIT │
├─────────────┼────────────────────────┼─────────┤
│ graceful-fs │ jsonfile │ ISC │
├─────────────┼────────────────────────┼─────────┤
│ mustache │ contrabando │ MIT │
└─────────────┴────────────────────────┴─────────┘
Done! Output saved as .\licenses.html
```
##### Html Output
## License
MIT