Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastianroming/license-report-generator
Saves all dependency licenses (node_modules) to a file
https://github.com/sebastianroming/license-report-generator
hacktoberfest
Last synced: 30 days ago
JSON representation
Saves all dependency licenses (node_modules) to a file
- Host: GitHub
- URL: https://github.com/sebastianroming/license-report-generator
- Owner: sebastianroming
- License: mit
- Created: 2018-09-06T06:42:57.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T06:16:20.000Z (4 months ago)
- Last Synced: 2024-12-10T15:36:59.162Z (about 2 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@wbmnky/license-report-generator
- Size: 301 KB
- Stars: 7
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @wbmnky/license-report-generator
[](https://github.com/sebastianroming/license-report-generator/actions/workflows/build-package.yml)
> finds and stores all dependency licenses
## Install
```
pnpm add @wbmnky/license-report-generator
```
## Usage
#### Options
```
{
useDevDependencies: boolean, // defaults to 'false'
packagePath: string, // defaults to 'process.cwd()'
packageName: string, // defaults to 'package.json'
depth: number, // defaults to '1'
template: string, // defaults to the contents of assets/template.txt
}
```
### Examples
#### Find licenses and write to file
```js
const licenser = require('@wbmnky/license-report-generator');
const options = {
useDevDependencies: true
};
return licenser.reporter.generate(options)
.then(rep => rep.write(path.resolve(__dirname, 'output.md')))
.catch((error) => {
console.log(error);
});
```
#### Return licenses as plain object
```js
const licenser = require('@wbmnky/license-report-generator');
const options = {
useDevDependencies: true,
depth: 2
};
return licenser.reporter.generate(options)
.then(rep => console.log(rep.plain()))
.catch((error) => {
console.log(error);
});
```
#### Use with your own template
```js
const licenser = require('@wbmnky/license-report-generator');
const fs = require('fs');
const path = require('path');
const options = {
template: fs.readFileSync(path.resolve(__dirname, 'template-table.txt'), 'utf8')
};
return licenser.reporter.generate(options)
.then(rep => rep.write(path.resolve(__dirname, 'output.md')))
.catch((error) => {
console.log(error);
});
```
#### Use with default table template
```js
const licenser = require('@wbmnky/license-report-generator');
return licenser.reporter.generate({})
.then(rep => rep.table())
.then(rep => rep.write(path.resolve(__dirname, 'output.md')))
.catch((error) => {
console.log(error);
});
```
#### CLI usage
```sh
license-report-generator [--table] [--depth Number|Infinity] [--template-dir path/to/templates/] [--template-file template.txt] [--out-dir path/to/output/] [--out-file license-output.md]
```
##### CLI options
- `--table` (Default: `false`) - use the default table template
- `--depth {number}|Infinity` (Default: `1`) - package depth, 0 is current project only
- `--with-dev-dependencies` (Default: `false`) - whether to include `devDependencies` in the license report or not
- `--out-dir` (Default: `process.cwd()`) - the output directory where the license file is written to
- `--out-file` (Default: `license-output.md`) - the output filename of the license file
- `--template-dir` (Default: `null`) - if you want to use an own template, specify the directory where to find the template
- `--template-file` (Default: `null`) - if you want to use an own template, specify the filename of the template
## Changelog
#### > 2.2.0
Subsequent changelogs can be found in the [Releases section](https://github.com/sebastianroming/license-report-generator/releases) of this repository.
#### 2.2.0
- feat: Added new variable `generatedAt` to use in a template
- fix: Removed Travis CI, replaced with GitHub Actions (`build` and `publish`)
- fix: Renamed interfaces and types
- chore: Replaced `yarn` with `pnpm` as the internal package manager
- chore: Updated dependencies to latest versions
#### 2.1.0
- Added CLI option to use as a global installed npm package
#### 2.0.0
- Removed `bower` support (fallback: [legacy version 0.2.0 @ npm](https://npmjs.com/package/license-report-generator))
- Return all found packages as plain object, without formatting / writing to file
- Added second example template for display as a table
## License
MIT © [Sebastian Roming](https://webmonkey.io)
## Credits
This is originally based on [ux-license-report](https://github.com/Banno/ux-license-report).