You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
Nicolai Ort a074b82c47 Fixed md output containing object as repo 2 years ago
bin Fixed md output containing object as repo 2 years ago
.drone.yml Added Release pipeline 2 years ago
.gitignore Added support for custom output folders 2 years ago
.npmignore Added npmignore 2 years ago
LICENSE Added license copyright information 2 years ago
README.md Fixed table in readme 2 years ago
exporter.js 0.0.5 w/ cli fixes 2 years ago
licenses.md added licenses to this project [SKIP CI] 2 years ago
package.json Version bump 2 years ago

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