| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
SPDX license conformance for NodeSecure
This package is available in the Node Package Repository and can be easily installed with npm or yarn.
$ npm i @nodesecure/conformance
# or
$ yarn add @nodesecure/conformanceExtract all licenses and their SPDX conformance from a given location
import * as conformance from "@nodesecure/conformance";
// Asynchronous
{
const licenses = await conformance.extractLicenses(
process.cwd()
);
console.log(licenses);
}
// Synchronous
{
const licenses = conformance.extractLicensesSync(
process.cwd()
);
console.log(licenses);
}Or detect SPDX conformance from a given Expression
import { licenseIdConformance } from "@nodesecure/conformance";
const conformance = licenseIdConformance("MIT").unwrap();
console.log(conformance);
/*
{
uniqueLicenseIds: ["MIT"],
spdxLicenseLinks: ["https://spdx.org/licenses/MIT.html#licenseText"],
spdx: {
osi: true,
fsf: true,
fsfAndOsi: true,
includesDeprecated: false
}
}
*/export interface SpdxLicenseConformance {
licenses: Record<string, string>;
spdx: {
osi: boolean;
fsf: boolean;
fsfAndOsi: boolean;
includesDeprecated: boolean;
};
}Extract License name from a given file content. Return null if it failed to detect the license.
Search and parse all licenses at the given string location or LocatedManifestManager.
Return all licenses with their SPDX conformance.
interface SpdxFileLicenseConformance extends SpdxLicenseConformance {
fileName: string;
}
interface SpdxUnidentifiedLicense {
licenseId: string;
reason: string;
}
interface SpdxExtractedResult {
/**
* List of licenses, each with its SPDX conformance details.
* This array includes all licenses found, conforming to the SPDX standards.
*/
licenses: SpdxFileLicenseConformance[];
/**
* A unique list of license identifiers (e.g., 'MIT', 'ISC').
* This list does not contain any duplicate entries.
* It represents the distinct licenses identified.
*/
uniqueLicenseIds: string[];
/**
* List of licenses that do not conform to SPDX standards or have invalid/unidentified identifiers.
* This array includes licenses that could not be matched to valid SPDX identifiers.
*/
unidentifiedLicenseIds?: SpdxUnidentifiedLicense[];
}Same as extractLicenses but use synchronous FS API.
To update the src/data/spdx.ts file just run the following npm script:
$ npm run spdx:refreshIt will fetch SPDX licenses here.
MIT
| Back | FazBrowse Home | New Git URL |