README

npm tarball license parser

dep build

Fetch all licenses and their SPDX conformance from a given npm tarball.

Requirements

Node.js v14 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @nodesecure/ntlp
# or
$ yarn add @nodesecure/ntlp

Usage example

import { fileURLToPath } from "url";
import { dirname } from "path";

import parseLicense from "@nodesecure/ntlp";

// CONSTANTS
const __dirname = dirname(fileURLToPath(import.meta.url));

const license = await parseLicense(__dirname);
console.log(license);

Return the following interface

interface license {
  uniqueLicenseIds: string[];
  spdxLicenseLinks: string[];
  spdx: {
    osi: boolean;
    fsf: boolean;
    fsfAndOsi: boolean;
    includesDeprecated: boolean;
  },
  from: string;
}

interface result {
  licenses: license[];
  hasMultipleLicenses: boolean;
  uniqueLicenseIds: string[];
}