pnpm-license-checker

This is a dependency free, small package that checks if the output of pnpm licenses complies with common "good" open source licenses.

It will only work with projects using pnpm >= 9.x.

Installation

1pnpm add pnpm-license-checker -D

Usage

1pnpm-license-checker

You may want to define a script in your package.json like:

1"scripts": {
2  "license:check": "pnpm-license-checker"
3}

Specifying Allowed Packages

Sometimes you may want to specifically allow certain packages that are internal or have a one-off license that you do not want to blanket allow.

To do so, you can configure this in .pnpm-license-checker.json:

1{
2  "allowedPackages": ["specific-package1"]
3}

Overriding Allowed Licenses

We have a default list of allowed licenses, if you do not want to specify your own, it will default to:

1// Default allowed licenses
2const defaultAllowedLicenses = [
3  'Apache-2.0',
4  'All Rights Reserved',
5  'Artistic-2.0',
6  'BlueOak-1.0.0',
7  '0BSD',
8  'BSD',
9  'BSD-2-Clause',
10  'BSD-3-Clause',
11  'CC0-1.0',
12  'CC-BY-4.0',
13  'CC BY-SA 4.0',
14  'ISC',
15  'LGPL-3.0-or-later',
16  'MIT',
17  'MIT-0',
18  'MPL-2.0',
19  'Public Domain',
20  'Python-2.0',
21  'Unicode-DFS-2016',
22  'Unlicense',
23  'UNLICENSED',
24];

However, if this list does not meet your needs, you are welcome to override it in .pnpm-license-checker.json:

1{
2  "allowedLicenses": ["BSD", "MIT"]
3}

This will replace all the default licenses, so if you want to use the default list and add some, you will need to provide all the licenses you want to support.