Package Exports

@nodesecure/licenses-conformance
@nodesecure/licenses-conformance/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nodesecure/licenses-conformance) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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):

_{Vincent Dhennin}
💻 🐛 📖

_Gentilhomme
💻 👀 🛡️

_{Kouadio Fabrice Nguessan}
🚧

License

MIT