Ever needed to see all the license info for a module and it's dependencies?
It's this easy:
npm install -g license-checker
mkdir foo
cd foo
npm install yui-lint
license-checker
You should see something like this:
├─ [email protected]
│ ├─ repository: http://github.com/chriso/cli
│ └─ licenses: MIT
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/node-glob
│ └─ licenses: UNKNOWN
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/node-graceful-fs
│ └─ licenses: UNKNOWN
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/inherits
│ └─ licenses: UNKNOWN
├─ [email protected]
│ └─ licenses: MIT
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/node-lru-cache
│ └─ licenses: MIT
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/node-lru-cache
│ └─ licenses: MIT
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/minimatch
│ └─ licenses: MIT
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/minimatch
│ └─ licenses: MIT
├─ [email protected]
│ ├─ repository: https://github.com/isaacs/sigmund
│ └─ licenses: UNKNOWN
└─ [email protected]
├─ licenses: BSD
└─ repository: http://github.com/yui/yui-lint
An asterisk next to a license name means that it was deduced from an other file than package.json (README, LICENSE, ...) You could see something like this:
└─ [email protected]
├─ repository: https://github.com/visionmedia/debug
└─ licenses: MIT*
--productiononly show production dependencies.--developmentonly show development dependencies.--unknownreport guessed licenses as unknown licenses.--onlyunknownonly list packages with unknown or guessed licenses.--jsonoutput in json format.--csvoutput in csv format.--out [filepath]write the data to a specific file.--customPathto add a custom Format file in JSON--exclude [list]exclude modules which licenses are in the comma-separated list from the output--relativeLicensePathoutput the location of the license files as relative paths
license-checker --json > /path/to/licenses.json
license-checker --csv --out /path/to/licenses.csv
license-checker --unknown
license-checker --customPath customFormatExample.js
license-checker --exclude 'MIT, MIT/X11, BSD, ISC'
license-checker --onlyunknown
var checker = require('license-checker');
checker.init({
start: '/path/to/start/looking'
}, function(json, err) {
if (err) {
//Handle error
} else {
//The sorted json data
}
});license-checker uses debug for internal logging. There’s two internal markers:
license-checker:errorfor errorslicense-checker:logfor non-errors
Set the DEBUG environment variable to one of these to see debug output:
$ export DEBUG=license-checker*; license-checker
scanning ./yui-lint
├─ [email protected]
│ ├─ repository: http://github.com/chriso/cli
│ └─ licenses: MIT
# ...
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent