@kingironman2011/license-checker 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Julian Speckmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cli/options.d.ts

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

package/dist/cli/options.js

@@ -0,0 +1,53 @@
+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/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,23 @@
+#!/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/dependencies/read-installed-packages.d.ts

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

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

@@ -0,0 +1,66 @@
+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/index.d.ts

@@ -0,0 +1,3 @@
+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/index.js

@@ -0,0 +1,28 @@
+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/cli/options.d.ts

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

package/dist/lib/cli/options.js

@@ -0,0 +1,53 @@
+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

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

package/dist/lib/cli.js

@@ -0,0 +1,23 @@
+#!/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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,66 @@
+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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,28 @@
+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

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

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

@@ -0,0 +1,12 @@
+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

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

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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,29 @@
+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

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

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

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

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

@@ -0,0 +1,12 @@
+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/output/write-output.d.ts

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

package/dist/output/write-output.js

@@ -0,0 +1,15 @@
+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/types.d.ts

@@ -0,0 +1,29 @@
+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/types.js

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

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@kingironman2011/license-checker",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "A NPM Package to check other packages licenses and extract them.",
+  "keywords": [
+    "checker",
+    "extractor",
+    "license",
+    "npm",
+    "package"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "KingIronMan2011",
+    "email": "IronMan@king-mc.de",
+    "url": "https://kingironman.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/KingIronMan2011/license-checker.git"
+  },
+  "bin": {
+    "license-checker": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./cli": "./dist/cli.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.6",
+    "oxfmt": "^0.78.0",
+    "oxlint": "^1.93.0",
+    "typescript": "^7.0.2"
+  },
+  "engines": {
+    "node": "^24",
+    "pnpm": "^12.21.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt --check .",
+    "lint": "oxlint .",
+    "lint:fix": "oxlint --fix .",
+    "types": "tsc --noEmit"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.