rtrvr
v0.0.11
Published
Sniff the entire license tree & validate against custom policies.
Downloads
4
Readme
rtrvr
Sniff the entire license tree & validate against custom policies.
Quick Start
Write your license policy in a file called .rtrvrrc
in the root
of your project, something like this:
{
"blacklist": [
"PATENTS"
],
"whitelist": [
"MIT"
]
}
Simply install rtrvr
(globally or locally, nobody gives a shit) and then
run rtrvr
in your project.
Configuration
- blacklist (array; required): a list of valid SPDX licenses that you would not like in your license chain.
- whitelist (array; required): a list of valid SPDX licenses that are allowed in your license chain.
- suppressWarnings (boolean; default: false): whether to hide all warnings.
- errorsOnly (boolean; default: false): if true, warnings & success messages will be suppressed.
- strict (boolean; default: false): if true, any licenses that are not in the whitelist will cause a crash.
- spdxOnly (boolean; default: false): if true, non-SPDX licenses will be disallowed.
- maxConcurrency (number; default: cpus - 1): the maximum number of packages to traverse at once.
License
Licensed under MIT license.
Copyright © 2017-present FoKo Inc. All rights reserved.