NPM License Checker
Table of Contents
- Introduction
- Description
- Changes
- CLI options
- Exclusions
- Examples
- Clarifications
- Custom format
- Programmatic API
- Debugging
- How Licenses are Found
- Related information sources on the internet
<a id="introduction"</aIntroduction
⚠️ Deprecation notice ⚠️
6.0.0 is the final release of license-checker-rseidelsohn.
We're moving everything over to @lizenz/checker. Its initial 1.0.0 is a 100% compatible drop-in replacement. Further development, updates, and features will happen there, as well.
🤔 But why?
This (admittedly oddly-named) package started as a fork of Dav Glass' "O.G." license-checker as the original hasn't been maintained for quite some time. The goal was to keep it up to date, to fix bugs and maybe to add a few new features here and there. Then reality kicked in, and this package has been sitting somewhat stale for a while, too 😅. There are other forks out there, as well. Most are pretty stale. Some have seen some activity. But overall, the landscape is a bit complicated right now.
We decided to fix this:
- create new GitHub & npm orgs so that not one single person has to be responsible going forward
- make it easier for contributors, maintainers and owners to join (and leave)
- deprecated this package here, while linking to a fresh new package, utilizing npm scopes and the aforementioned orgs
- continue development over there, hopefully encouraging other forks to join, as well
Changes to the original
I changed the original exclude argument to excludeLicenses in order to prevent confusion and better align it with the excludePackages argument. Also, the argument includeLicenses has been added for listing only packages that include the licenses listed.
<a id="description"</aDescription
Ever needed to see all the license info for a module and its dependencies?
It's this easy:
npm install -g license-checker-rseidelsohn
mkdir foo
cd foo
npm install yui-lint
license-checker-rseidelsohn