@nodesecure/licenses-conformance
v2.1.0
Published
Check spdx license expressions
Downloads
275
Readme
SPDX Licenses conformance
NodeSecure SPDX licenses conformance. Project forked/inspired from cutenode/conformance.
Requirements
- Node.js v18 or higher
Getting Started
This package is available in the Node Package Repository and can be easily installed with npm or yarn.
This repository is inspired by cutenode/conformance
$ npm i @nodesecure/licenses-conformance
# or
$ yarn add @nodesecure/licenses-conformance
Usage example
import { licenseIdConformance } from "@nodesecure/licenses-conformance";
const result = licenseIdConformance("MIT");
if (result.ok) {
console.log(result.value);
}
/*
{
uniqueLicenseIds: ["MIT"],
spdxLicenseLinks: ["https://spdx.org/licenses/MIT.html#licenseText"],
spdx: {
osi: true,
fsf: true,
fsfAndOsi: true,
includesDeprecated: false
}
}
*/
API
interface spdxLicenseConformance {
uniqueLicenseIds: string[];
spdxLicenseLinks: string[];
spdx?: {
osi: boolean;
fsf: boolean;
fsfAndOsi: boolean;
includesDeprecated: boolean;
};
}
function licenseIdConformance(
licenseID: string
): { ok: true, value: spdxLicenseConformance } | { ok: false, value: Error };
function searchSpdxLicenseId(contentStr: string): string | null;
Updating SPDX licenses
To update the src/spdx.json
file just run the following npm script:
$ npm run spdx:refresh
It will fetch SPDX licenses here.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
License
MIT