Please use registered SPDX license id in package.json
Opened this issue · 2 comments
Hi!
I would like to suggest a very minor enhancement. Consider this when you get a chance :)
I noticed that this package uses the zlib License per the README.md
file. This is a fine choice. However, the package.json
file does not explicitly indicate that. Ideally, the package.json
file would include a license
(or licenses
) field using an officially registered SPDX license id (see https://spdx.org/licenses/), or the LICENSE
file would start with the full name of the license, per https://spdx.org/licenses/Zlib.html#licenseText.
The reason why it is generally helpful to use an officially registered SPDX license id is that those of us who use an automated license checker (e.g., https://www.npmjs.com/package/license-checker) can automatically process this package without further whitelisting.
The other side benefit is that npm will no longer state that there is no license on this package (see https://www.npmjs.com/package/char-split)
Thank you!
Hello Julien-bot! 👋 There looks like there is a license entry in the package.json already.
And I had completely forgotten about this package. :)
Hi @marcello3d! Indeed there is, but surprisingly enough, license-checker
requires the license id to be properly capitalized, i.e. Zlib
vs zlib
:( Per https://spdx.org/spdx-license-list/matching-guidelines (4.1.1), the match should be case insensitive. I will file an enhancement request against license-checker
.