Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kakkun61/elm-license-checker
Check the licenses of Elm packages.
https://github.com/kakkun61/elm-license-checker
elm hacktoberfest javascript license purescript
Last synced: 3 months ago
JSON representation
Check the licenses of Elm packages.
- Host: GitHub
- URL: https://github.com/kakkun61/elm-license-checker
- Owner: kakkun61
- License: bsd-3-clause
- Created: 2020-01-06T21:52:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T22:56:54.000Z (about 1 year ago)
- Last Synced: 2024-05-01T18:56:01.206Z (8 months ago)
- Topics: elm, hacktoberfest, javascript, license, purescript
- Language: PureScript
- Homepage: https://www.npmjs.com/package/elm-license-checker
- Size: 486 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Elm License Checker
[![NPM][npm-badge]][npm] [![Pursuit][pursuit-badge]][pursuit] [![CI][ci-badge]][ci] [![Gitter][chat-badge]][chat] [![Sponsor][sponsor-badge]][sponsor]
[npm]: https://www.npmjs.com/package/elm-license-checker
[npm-badge]: https://img.shields.io/npm/v/elm-license-checker
[pursuit]: https://pursuit.purescript.org/packages/purescript-elm-license-checker/
[pursuit-badge]: https://img.shields.io/badge/pursuit-v2.4.0-%231d222d
[ci]: https://github.com/kakkun61/elm-license-checker/actions?query=workflow%3Atest
[ci-badge]: https://github.com/kakkun61/elm-license-checker/workflows/test/badge.svg
[chat]: https://gitter.im/elm-license-checker/community
[chat-badge]: https://badges.gitter.im/elm-license-checker/community.svg
[sponsor]: https://github.com/sponsors/kakkun61
[sponsor-badge]: https://img.shields.io/badge/Sponsor-%E2%9D%A4-red?logo=GitHub
Treats the licenses of the dependent packages.
This is inspired by [NPM License Checker](https://github.com/davglass/license-checker).
## CLI Interface
You can show the package information with the selected fields.
```
> elm-license-checker --customPath format.json
├─ elm/[email protected]
│ ├─ name: elm/json
│ ├─ version: 1.1.3
│ ├─ summary: Encode and decode JSON values
│ ├─ license: BSD-3-Clause
│ └─ licenseFile: C:\Users\kazuki\AppData\Roaming\elm\0.19.1\packages\elm\json\1.1.3\LICENSE
├─ elm/[email protected]
│ ├─ name: elm/time
│ ├─ version: 1.0.0
│ ├─ summary: Work with POSIX times, time zones, years, months, days, hours, seconds, etc.
│ ├─ license: BSD-3-Clause
│ └─ licenseFile: C:\Users\kazuki\AppData\Roaming\elm\0.19.1\packages\elm\time\1.0.0\LICENSE
:
```
See the section “Compatibility with NPM License Checker” for options.
### Custom Format
Fields that a format file contains are outputted. Values of fields that licenses do not have are given as ones of fields in a format file. Please also refer [a document of the NPM License Checker](https://github.com/davglass/license-checker#custom-format).
There are an example file in _test-asset/format.json_.
## Library Interface
The following is how to use this as a module.
The JavaScript interface is compatible with NPM License Checker, but is actually a subset.
See the section “Compatibility with NPM License Checker”.
```javascript
const elc = require('elm-license-checker');
elc.init(
{ start: '/path/to/elm-application' },
function (err, packages) {
if (err) {
// handle the error
} else {
// use the packages
}
}
);
```
The PureScript interface is also available.
```purescript
import Prelude
import Effect (Effect)
import ElmLicenseChecker (init)
main :: Effect Unit
main = do
packages <- init "/path/to/elm-application"
-- use the packages
```
## Compatibility with NPM License Checker
Statuses are:
- ⭕ implemented
- ❌ ignored
- 📈 decided to be implemented but not yet done
- 📉 decided to be ignored but not yet done
- ⌛ not decided whether implemented or not
### Options
| Option | CLI | JS | PS | Description |
|--------------------------|:---:|:--:|:--:|-----------------------------------------------------------------------------------------------------|
| `production` | ⌛ | ⌛ | ⌛ | only show production dependencies |
| `development` | ⌛ | ⌛ | ⌛ | only show development dependencies |
| `start` | 📈 | ⭕ | ⭕ | give where elm.json is |
| `unknown` | ⌛ | ⌛ | ⌛ | report guessed licenses as unknown licenses |
| `onlyunknown` | ⌛ | ⌛ | ⌛ | only list packages with unknown or guessed licenses |
| `json` | ⭕ | 📈 | ❌ | output in json format |
| `csv` | ⌛ | ⌛ | ❌ | output in csv format |
| `csvComponentPrefix` | ⌛ | ⌛ | ⌛ | prefix column for component in csv format |
| `out` | ⭕ | ❌ | ❌ | write the data to a specific file |
| `customPath` | ⭕ | ⭕ | ❌ | add a custom format file in JSON |
| `exclude` | ⌛ | ⌛ | ⌛ | exclude modules which licenses are in the comma-separated list from the output |
| `relativeLicensePath` | ⌛ | ⌛ | ⌛ | output the location of the license files as relative paths |
| `summary` | ⌛ | ⌛ | ⌛ | output a summary of the license usage |
| `failOn` | ⌛ | ⌛ | ⌛ | fail (exit with code 1) on the first occurrence of the licenses of the semicolon-separated list |
| `onlyAllow` | ⌛ | ⌛ | ⌛ | fail (exit with code 1) on the first occurrence of the licenses not in the semicolon-separated list |
| `packages` | ⌛ | ⌛ | ⌛ | restrict output to the packages (package@version) in the semicolon-separated list |
| `excludePackages` | ⌛ | ⌛ | ⌛ | restrict output to the packages (package@version) not in the semicolon-separated list |
| `excludePrivatePackages` | ⌛ | ⌛ | ⌛ | restrict output to not include any package marked as private |
| `direct` | ⌛ | ⌛ | ⌛ | look for direct dependencies only |
### Custom Format
There are compatible fields:
- ⭕ `name`
- ⭕ `version`
- ⭕ `description` the same as `summary`
- ⭕ `copyright` always empty
- ⭕ `licenses` the same as `license`
- ⭕ `licenseFile`
- ⭕ `licenseText`
- ⭕ `licenseModified` always empty
There are added fields:
- ⭕ `summary`
- ⭕ `license`