@kingironman2011/license-checker 1.0.0 → 1.0.1

package/dist/cli/options.js

@@ -8,6 +8,8 @@ export function getNormalizedArguments(args) {
         const arg = args[index];
         if (arg === "--silent" || arg === "-s")
             options.silent = true;
+        else if (arg === "--check")
+            options.check = true;
         else if (arg === "--production" || arg === "--prod") {
             options.production = true;
             options.development = false;
@@ -44,6 +46,7 @@ function printHelp() {
     console.log(`Usage: license-checker [project-directory] [options]
 
 Options:
+  --check               List dependencies with no license metadata or license file
   --silent, -s          Do not print the license report
   --extract, --files <dir> Copy license files into <dir>
   --production, --prod  Scan production dependencies only

package/dist/cli.js

@@ -6,8 +6,24 @@ import { runLicenseCheck } from "./index.js";
 async function main() {
     const options = getNormalizedArguments(process.argv.slice(2));
     const items = await runLicenseCheck(options);
+    const missing = options.check
+        ? items.filter((item) => item.license.toLowerCase() === "unknown" && item.licenseFiles.length === 0)
+        : [];
+    if (options.check && missing.length > 0)
+        process.exitCode = 1;
     if (options.silent)
         return;
+    if (options.check) {
+        if (missing.length > 0) {
+            console.log(`Found ${missing.length} dependencies with missing licenses:\n`);
+            for (const item of missing)
+                console.log(`${item.name}@${item.version}`);
+        }
+        else {
+            console.log(`All ${items.length} dependencies have license metadata or license files.`);
+        }
+        return;
+    }
     console.log(`Found ${items.length} dependencies:\n`);
     for (const item of items)
         console.log(`${item.name}@${item.version}  ${item.license}`);

package/dist/types.d.ts

@@ -12,6 +12,7 @@ export interface LicenseCheckOptions {
     production?: boolean;
     development?: boolean;
     silent?: boolean;
+    check?: boolean;
     files?: string;
 }
 export interface PackageJson {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kingironman2011/license-checker",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A NPM Package to check other packages licenses and extract them.",
   "keywords": [
     "checker",

package/dist/lib/cli/options.d.ts

@@ -1,4 +0,0 @@
-import type { LicenseCheckOptions } from "../types.js";
-export interface CliOptions extends LicenseCheckOptions {
-}
-export declare function getNormalizedArguments(args: string[]): CliOptions;

package/dist/lib/cli/options.js

@@ -1,53 +0,0 @@
-import path from "node:path";
-export function getNormalizedArguments(args) {
-    const options = {
-        start: process.cwd(),
-        silent: false,
-    };
-    for (let index = 0; index < args.length; index += 1) {
-        const arg = args[index];
-        if (arg === "--silent" || arg === "-s")
-            options.silent = true;
-        else if (arg === "--production" || arg === "--prod") {
-            options.production = true;
-            options.development = false;
-        }
-        else if (arg === "--development" || arg === "--dev") {
-            options.production = false;
-            options.development = true;
-        }
-        else if (arg === "--all") {
-            options.production = false;
-            options.development = false;
-        }
-        else if (arg === "--extract" || arg === "-o" || arg === "--files") {
-            const value = args[index + 1];
-            if (!value || value.startsWith("-"))
-                throw new Error(`${arg} requires a directory`);
-            options.files = path.resolve(value);
-            index += 1;
-        }
-        else if (arg === "--help" || arg === "-h") {
-            printHelp();
-            process.exit(0);
-        }
-        else if (arg.startsWith("-")) {
-            throw new Error(`Unknown option: ${arg}`);
-        }
-        else {
-            options.start = path.resolve(arg);
-        }
-    }
-    return options;
-}
-function printHelp() {
-    console.log(`Usage: license-checker [project-directory] [options]
-
-Options:
-  --silent, -s          Do not print the license report
-  --extract, --files <dir> Copy license files into <dir>
-  --production, --prod  Scan production dependencies only
-  --development, --dev  Scan development dependencies only
-  --all                 Scan both dependency scopes (default)
-  --help, -h            Show this help`);
-}

package/dist/lib/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/lib/cli.js

@@ -1,23 +0,0 @@
-#!/usr/bin/env node
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import { getNormalizedArguments } from "./cli/options.js";
-import { runLicenseCheck } from "./index.js";
-async function main() {
-    const options = getNormalizedArguments(process.argv.slice(2));
-    const items = await runLicenseCheck(options);
-    if (options.silent)
-        return;
-    console.log(`Found ${items.length} dependencies:\n`);
-    for (const item of items)
-        console.log(`${item.name}@${item.version}  ${item.license}`);
-    if (options.files)
-        console.log(`\nLicense files copied to ${options.files}`);
-}
-const invokedPath = process.argv[1] ? path.resolve(process.argv[1]) : "";
-if (invokedPath === fileURLToPath(import.meta.url)) {
-    main().catch((error) => {
-        console.error(error instanceof Error ? error.message : error);
-        process.exitCode = 1;
-    });
-}

package/dist/lib/dependencies/read-installed-packages.d.ts

@@ -1,2 +0,0 @@
-import type { DependencyLicense, DependencyScope } from "../types.js";
-export declare function readInstalledPackages(projectDir: string, scope: Exclude<DependencyScope, "both">): Promise<DependencyLicense[]>;

package/dist/lib/dependencies/read-installed-packages.js

@@ -1,66 +0,0 @@
-import { readFile, realpath } from "node:fs/promises";
-import path from "node:path";
-async function resolveDependency(parentDir, name) {
-    let currentDir = parentDir;
-    while (true) {
-        const candidate = path.join(currentDir, "node_modules", name, "package.json");
-        try {
-            await readFile(candidate, "utf8");
-            return path.dirname(candidate);
-        }
-        catch {
-            const parent = path.dirname(currentDir);
-            if (parent === currentDir)
-                return undefined;
-            currentDir = parent;
-        }
-    }
-}
-export async function readInstalledPackages(projectDir, scope) {
-    const root = JSON.parse(await readFile(path.join(projectDir, "package.json"), "utf8"));
-    const roots = scope === "production"
-        ? { ...root.dependencies, ...root.optionalDependencies }
-        : (root.devDependencies ?? {});
-    const found = new Map();
-    const visited = new Set();
-    async function visit(packagePath, dependencyName) {
-        let realPackagePath;
-        try {
-            realPackagePath = await realpath(packagePath);
-        }
-        catch {
-            return;
-        }
-        if (visited.has(realPackagePath))
-            return;
-        visited.add(realPackagePath);
-        const pkg = JSON.parse(await readFile(path.join(packagePath, "package.json"), "utf8"));
-        const name = pkg.name ?? dependencyName;
-        const version = pkg.version ?? "unknown";
-        const key = `${name}@${version}`;
-        found.set(key, {
-            name,
-            version,
-            license: pkg.license && typeof pkg.license === "string"
-                ? pkg.license
-                : ((typeof pkg.license === "object" ? pkg.license.type : undefined) ??
-                    pkg.licenses?.map(({ type }) => type ?? "Unknown").join(" OR ") ??
-                    "Unknown"),
-            scope,
-            packagePath,
-            licenseFiles: [],
-        });
-        const dependencies = { ...pkg.dependencies, ...pkg.optionalDependencies };
-        for (const childName of Object.keys(dependencies).toSorted()) {
-            const childPath = await resolveDependency(packagePath, childName);
-            if (childPath)
-                await visit(childPath, childName);
-        }
-    }
-    for (const name of Object.keys(roots).toSorted()) {
-        const packagePath = await resolveDependency(projectDir, name);
-        if (packagePath)
-            await visit(packagePath, name);
-    }
-    return [...found.values()];
-}

package/dist/lib/index.d.ts

@@ -1,3 +0,0 @@
-import type { DependencyLicense, LicenseCheckOptions } from "./types.js";
-export type { DependencyLicense, DependencyScope, LicenseCheckOptions, } from "./types.js";
-export declare function runLicenseCheck(options?: LicenseCheckOptions): Promise<DependencyLicense[]>;

package/dist/lib/index.js

@@ -1,28 +0,0 @@
-import path from "node:path";
-import { readInstalledPackages } from "./dependencies/read-installed-packages.js";
-import { collectLicenseResults } from "./licenses/collect-license-results.js";
-import { writeIndividualLicenseFilesToDir } from "./output/write-output.js";
-export async function runLicenseCheck(options = {}) {
-    const projectDir = path.resolve(options.start ?? process.cwd());
-    const scopes = options.production
-        ? ["production"]
-        : options.development
-            ? ["development"]
-            : ["production", "development"];
-    const results = new Map();
-    for (const scope of scopes) {
-        const packages = await collectLicenseResults(await readInstalledPackages(projectDir, scope));
-        for (const item of packages) {
-            const key = `${item.name}@${item.version}`;
-            const existing = results.get(key);
-            if (existing)
-                existing.scope = "both";
-            else
-                results.set(key, item);
-        }
-    }
-    const items = [...results.values()].toSorted((a, b) => a.name.localeCompare(b.name) || a.version.localeCompare(b.version));
-    if (options.files)
-        await writeIndividualLicenseFilesToDir(path.resolve(options.files), items);
-    return items;
-}

package/dist/lib/licenses/collect-license-results.d.ts

@@ -1,2 +0,0 @@
-import type { DependencyLicense } from "../types.js";
-export declare function collectLicenseResults(packages: DependencyLicense[]): Promise<DependencyLicense[]>;

package/dist/lib/licenses/collect-license-results.js

@@ -1,12 +0,0 @@
-import { readdir } from "node:fs/promises";
-export async function collectLicenseResults(packages) {
-    for (const item of packages) {
-        const entries = await readdir(item.packagePath, { withFileTypes: true });
-        item.licenseFiles = entries
-            .filter((entry) => entry.isFile() &&
-            /^(license|licence|copying|notice)(\.|$)/i.test(entry.name))
-            .map((entry) => entry.name)
-            .toSorted((a, b) => a.localeCompare(b));
-    }
-    return packages.toSorted((a, b) => a.name.localeCompare(b.name) || a.version.localeCompare(b.version));
-}

package/dist/lib/output/write-output.d.ts

@@ -1,2 +0,0 @@
-import type { DependencyLicense } from "../types.js";
-export declare function writeIndividualLicenseFilesToDir(outputDir: string, items: DependencyLicense[]): Promise<void>;

package/dist/lib/output/write-output.js

@@ -1,15 +0,0 @@
-import { cp, mkdir, writeFile } from "node:fs/promises";
-import path from "node:path";
-export async function writeIndividualLicenseFilesToDir(outputDir, items) {
-    for (const item of items) {
-        const safeName = item.name.replaceAll("/", "+");
-        const destination = path.join(outputDir, item.scope, `${safeName}@${item.version}`);
-        await mkdir(destination, { recursive: true });
-        for (const file of item.licenseFiles) {
-            await cp(path.join(item.packagePath, file), path.join(destination, file));
-        }
-        if (item.licenseFiles.length === 0) {
-            await writeFile(path.join(destination, "LICENSE-INFO.txt"), `License metadata: ${item.license}\n`);
-        }
-    }
-}

package/dist/lib/types.d.ts

@@ -1,29 +0,0 @@
-export type DependencyScope = "production" | "development" | "both";
-export interface DependencyLicense {
-    name: string;
-    version: string;
-    license: string;
-    scope: DependencyScope;
-    packagePath: string;
-    licenseFiles: string[];
-}
-export interface LicenseCheckOptions {
-    start?: string;
-    production?: boolean;
-    development?: boolean;
-    silent?: boolean;
-    files?: string;
-}
-export interface PackageJson {
-    name?: string;
-    version?: string;
-    license?: string | {
-        type?: string;
-    };
-    licenses?: Array<{
-        type?: string;
-    }>;
-    dependencies?: Record<string, string>;
-    optionalDependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-}

package/dist/lib/types.js

@@ -1 +0,0 @@
-export {};