https://github.com/wolfadex/elm-license-finder
Lists license for your Elm dependencies
https://github.com/wolfadex/elm-license-finder
Last synced: about 1 year ago
JSON representation
Lists license for your Elm dependencies
- Host: GitHub
- URL: https://github.com/wolfadex/elm-license-finder
- Owner: wolfadex
- License: mit
- Created: 2019-12-27T05:23:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-28T23:11:04.000Z (almost 3 years ago)
- Last Synced: 2024-10-21T07:44:49.606Z (over 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elm License Finder
A simple node app for collecting license information for Elm dependencies. Gives you:
- Total dependency count
- Portion of dependencies that are direct
- Portion of dependencies that are indirect
- Totals of licenses by name
- Table of package, version, license, and whether it's a direct or indirect dependency
\*_For packages, all dependencies are direct._
---
## Use as a command:
- Run `yarn global add elm-license-finder` or `npm install -g elm-license-finder`
- Navigate to the directory with your `elm.json`
- Run `elm-license-finder`
#### Options
- `--dir ` The path to the directory containing your elm.json, for when you aren't running it fromt the root of the project.
- `--output ` To specify an output format that isn't the default table. Formats include:
- `json`
- `csv` formatted as `'name,version,"license",type'` with the license escaped.
## Use as a module:
Run `yarn add elm-license-finder` or `npm install elm-license-finder`
```
const elmLicenseFinder = require("elm-license-finder");
const dependencies = elmLicenseFinder();
// returns an object with the structure:
// {
// "package/name": {
// version: "1.2.3",
// license: "MIT",
// type: "direct",
// }
// }
```
If you're running it from a different directory than the one with `elm.json` in it
```
const elmLicenseFinder = require("elm-license-finder");
const path = require("path");
const dependencies = elmLicenseFinder(path.resolve("path", "to", "elm", "project"));
```