Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mymindstorm/npm-license-generator
Generate a file with license text from NPM dependencies
https://github.com/mymindstorm/npm-license-generator
license license-management npm
Last synced: about 2 months ago
JSON representation
Generate a file with license text from NPM dependencies
- Host: GitHub
- URL: https://github.com/mymindstorm/npm-license-generator
- Owner: mymindstorm
- License: mit
- Created: 2020-05-19T23:35:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-15T02:10:32.000Z (4 months ago)
- Last Synced: 2024-10-29T21:31:26.415Z (2 months ago)
- Topics: license, license-management, npm
- Language: TypeScript
- Homepage:
- Size: 302 KB
- Stars: 12
- Watchers: 2
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NPM License Generator
Generate a page with a copy of NPM dependency licenses. [Example output](https://mymindstorm.github.io/npm-license-generator/example_licenses)
## Usage
Install:
```bash
npm install --global npm-license-generator
```
Options:
```bash
$ npm-license-generator --help
Usage:
npm-license-generator [folder]
Positionals:
folder Folder of NPM project. Defaults to current working directory [string]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--out-path HTML output path [string] [default: "./licenses.html"]
--registry URL of package registry to use
[string] [default: "https://registry.npmjs.org"]
--tmp-folder-name Name of temporary folder
[string] [default: ".license-gen-tmp"]
--template Path to custom mustache template [string]
--no-group Do not group licenses [boolean] [default: false]
--package-lock Run on all packages listed in package-lock.json
[boolean] [default: false]
--no-spdx Do not download license file based on SPDX string
[boolean] [default: false]
--only-spdx Do not download tarballs, only use SPDX string
[boolean] [default: false]
--error-missing Exit 1 if no license is present for a package
[boolean] [default: false]
```
## Use your own template
Supply your own template using the `--template` option. Templates are written in [Mustache](https://mustache.github.io/). Your template does not have to be HTML, change the output file name using `--out-path`.
By default, Mustache is given two variables:
- `name`: the package name
- `renderLicenses`: an array of [GroupedLicense](https://github.com/mymindstorm/npm-license-generator/blob/ce81d002cd22320076e029ed2a612d4e6ad9dacf/src/types.d.ts#L45-L53). When using `--no-group`, an array of [LicenseInfo](https://github.com/mymindstorm/npm-license-generator/blob/ce81d002cd22320076e029ed2a612d4e6ad9dacf/src/types.d.ts#L32-L43) is passed instead.
Check the [lib](https://github.com/mymindstorm/npm-license-generator/tree/master/lib) folder for example templates.
## How licenses are found
1. Get package version and tarball location from package.lock
2. Look for licenses in node_modules if avalible
3. Otherwise download tarball, extract, look for licenses, and use that
4. Otherwise, evaluate SPDX string and use a file from https://github.com/spdx/license-list-data/tree/master/text