This repository has been archived on 2021-03-09. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Nicolai Ort a074b82c47
continuous-integration/drone/push Build is passing Details
Fixed md output containing object as repo
2021-02-13 13:47:05 +01:00
bin Fixed md output containing object as repo 2021-02-13 13:47:05 +01:00
.drone.yml Added Release pipeline 2020-12-31 16:29:16 +01:00
.gitignore Added support for custom output folders 2021-01-02 20:29:05 +01:00
.npmignore Added npmignore 2020-12-31 16:30:33 +01:00
LICENSE Added license copyright information 2020-12-31 14:42:14 +01:00
README.md Fixed table in readme 2021-01-25 10:54:44 +00:00
exporter.js 0.0.5 w/ cli fixes 2020-12-31 17:53:13 +01:00
licenses.md added licenses to this project [SKIP CI] 2021-01-02 20:40:47 +01:00
package.json Version bump 2021-02-13 13:45:33 +01:00

README.md

ODIT.Services - License Exporter

Build Status

A simple license exporter that crawls your package.json and provides you with information about your dependencies' licenses. You can export this information into json(even prettyfied) and markdown. We use this in our open source projects to credit the awesome work of other open source contributors.

Install

Via yarn/npm:

yarn add @odit/license-exporter
# Or
npm i @odit/license-exporter

CLI Usage

Export only your dependencies to json: licenseexporter --json Export all dependencies to json: licenseexporter --json --recursive

Export only your dependencies to markdown: licenseexporter --md Export all dependencies to markdown: licenseexporter --md --recursive

Options

Arg Description Type Default
-j, --json Exports the license information into ./licenses.json as json. flag/[boolean] N/A
-p, --pretty Prettify the json output. flag/[boolean] N/A
-m, --markdown Exports the license information into ./licenses.md as markdown. flag/[boolean] N/A
-r, --recursive Include all of the dependencies' subdependencies. flag/[boolean] N/A
-o, --output Output folder for the exports. [string] Current folder
-i, --input Path to the input folder containing your package.json and node_modules [string] Current folder
-h, --help Show help flag/[boolean] N/A
-v, --version Show version number flag/[boolean] N/A