https://github.com/inthepocket/npm-license-scraper
📜 Dead simple license scraper for npm packages (with zero real dependencies)
https://github.com/inthepocket/npm-license-scraper
cli license npm scraper typescript
Last synced: about 1 year ago
JSON representation
📜 Dead simple license scraper for npm packages (with zero real dependencies)
- Host: GitHub
- URL: https://github.com/inthepocket/npm-license-scraper
- Owner: inthepocket
- License: mit
- Created: 2019-11-12T15:01:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T10:10:55.000Z (about 2 years ago)
- Last Synced: 2025-01-29T15:59:33.078Z (over 1 year ago)
- Topics: cli, license, npm, scraper, typescript
- Language: TypeScript
- Size: 915 KB
- Stars: 7
- Watchers: 22
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### 📜 Dead simple license scraper with zero dependencies
[](https://www.npmjs.com/package/@inthepocket/npm-license-scraper)
## Introduction
`npm-license-scraper` will scan your `package.json` and `node_modules` to generate a JSON file including the licenses of all open source packages that are being used.
## Usage
```shell
$ npm i -D @inthepocket/npm-license-scraper
# Via npx
$ npx npm-license-scraper
# Directly
$ node node_modules/.bin/npm-license-scraper
```
### Options
- `--export [filename]`: Export to a JSON file. (default `./licenses.json`)
- `--includeDev`: Include dev dependencies in output (default `false`)
- `--exclude [package|package,package,package]`: Ignore certain packages from the check (e.g submodules, monorepo or private packages)
## Output format
The exported JSON file has the following format:
```ts
type JSON = Array<{
name: string;
version: string;
license: string;
url: string;
isValid: boolean;
}>;
```
Example:
```json
[
{
"package": "react",
"version": "18.0.0",
"license": "MIT",
"url": "https://reactjs.org/",
"isValid": true
},
{
"package": "react-native",
"version": "0.69.3",
"license": "MIT",
"url": "https://npmjs.com/package/react-native",
"isValid": true
}
]
```