license-crawler

crawls a npm package and it's dependencies for their licenses

Installation

npm

1npm install license-crawler

Usage

NodeJS Example

1// Import license-crawler
2var crawler = require('license-crawler');
3
4
5
6// setting options
7const options = {
8  input: './',                  // input folder which contains package.json
9  out: './reportLicenses.json', // output file
10  production: false,            // if true don't check devDependencies
11  statistics: true,             // generate statistics
12  exclude: [],
13  sorted: 'license',            // 'license' or 'package'
14  format: 'json',               // 'json' or 'txt'
15};
16
17// Set configuration
18crawler.crawlLicenses(options);

JavaScript Example

1// Import license-crawler
2var crawler = require('license-crawler');
3
4crawler.crawlLicenses({
5  input: './',                  // input folder which contains package.json
6  out: './reportLicenses.json', // output file
7  production: false,             // if true don't check devDependencies
8  statistics: true,             // generate statistics
9  exclude: [],
10  sorted: 'license',            // 'license' or 'package'
11  format: 'json',               // 'json' or 'txt'
12});

Output

format: 'json' license sorted

1{
2  "MIT": {
3    "total": 34,
4    "percentage": "45.33 %",
5    "packages": [...]
6  },
7  "Apache-2.0": {
8    "total": 24,
9    "percentage": "32 %",
10    "packages": [...]
11  },
12  "ISC": {
13    "total": 11,
14    "percentage": "14.67 %",
15    "packages": [...]
16  },
17  "BSD-3-Clause": {
18    "total": 2,
19    "percentage": "2.67 %",
20    "packages": [...]
21  },
22  "BSD-2-Clause": {
23    "total": 1,
24    "percentage": "1.33 %",
25    "packages": [...]
26  },
27  "UNKNOWN": {
28    "total": 3,
29    "percentage": "4 %",
30    "packages": [...]
31  }
32}

format: 'txt' package sorted

1├─license-crawler@0.0.3:
2│  ├─ license: MIT
3│  ├─@types/node@9.6.6:
4│  │  ├─ license: MIT
5│  ├─tslint@5.9.1:
6│  │  ├─ license: Apache-2.0
7│  │  ├─babel-code-frame@^6.22.0:
8│  │  │  ├─ license: MIT

License

This project is licensed under the MIT License - see the LICENSE file for details.