@nodesecure/licenses-conformance
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

SPDX Licenses conformance

version Maintenance OpenSSF Scorecard mit build

NodeSecure SPDX licenses conformance. Project forked/inspired from cutenode/conformance.

Requirements

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 ✨

All Contributors

Thanks goes to these wonderful people (emoji key):

Vincent Dhennin
Vincent Dhennin

💻 🐛 📖
Gentilhomme
Gentilhomme

💻 👀 🛡️
Kouadio Fabrice Nguessan
Kouadio Fabrice Nguessan

🚧

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i @nodesecure/licenses-conformance

Weekly Downloads

70

Version

2.1.0

License

MIT

Unpacked Size

106 kB

Total Files

8

Last publish

Collaborators

  • pierred
  • antoine-coulon
  • kawacrepe
  • fraxken
  • tonygo