license-checker-plugin 1.0.0 → 1.0.2

package/dist/LicensePluginCore.d.ts

@@ -15,8 +15,12 @@ export interface LicensePluginOptions {
     includeHomepage?: boolean;
     /** Include the author/publisher in each entry. */
     includeAuthor?: boolean;
-    /** Exclude specific packages from the output by name. */
-    excludePackages?: string[];
+    /**
+     * Exclude specific packages from the output.
+     * Can be a list of package names, or a predicate function
+     * `(packageName: string) => boolean`.
+     */
+    excludePackages?: (string | ((name: string) => boolean))[];
     /**
      * Allow only these licenses. When set, the build fails if any bundled
      * package has a license not in this list.
@@ -78,6 +82,8 @@ export declare class LicensePluginCore {
     private buildOutputItems;
     private recordReport;
     private mergeReports;
+    private readLicenseFromPackage;
+    private readLicenseFileText;
     format(items: OutputItem[]): string;
     private filterLicenseFields;
     private createFormatter;

package/dist/LicensePluginCore.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LicensePluginCore = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
 const LicenseDatabase_1 = require("./checker/LicenseDatabase");
+const BuiltInLicenseChecker_1 = require("./checker/BuiltInLicenseChecker");
 const HtmlFormatter_1 = require("./formatter/HtmlFormatter");
 const JsonFormatter_1 = require("./formatter/JsonFormatter");
 const MarkdownFormatter_1 = require("./formatter/MarkdownFormatter");
@@ -68,11 +71,15 @@ class LicensePluginCore {
     resolveLicenseEntries(packages) {
         const entries = [];
         for (const pkgInfo of packages.values()) {
-            if (this.options.excludePackages.includes(pkgInfo.name))
+            if (this.options.excludePackages.some((e) => (typeof e === 'function' ? e(pkgInfo.name) : e === pkgInfo.name)))
                 continue;
+            let licenseInfo = this.db.getLicense(pkgInfo.name, pkgInfo.version);
+            if (licenseInfo.license === 'UNKNOWN') {
+                licenseInfo = this.readLicenseFromPackage(pkgInfo);
+            }
             entries.push({
                 info: pkgInfo,
-                licenseInfo: this.filterLicenseFields(this.db.getLicense(pkgInfo.name, pkgInfo.version)),
+                licenseInfo: this.filterLicenseFields(licenseInfo),
             });
         }
         return entries;
@@ -119,6 +126,67 @@ class LicensePluginCore {
         }
         return merged;
     }
+    readLicenseFromPackage(pkgInfo) {
+        try {
+            const raw = (0, fs_1.readFileSync)(pkgInfo.packageJsonPath, 'utf-8');
+            const pkg = JSON.parse(raw);
+            let licenseStr;
+            if (pkg.license) {
+                licenseStr = typeof pkg.license === 'string' ? pkg.license : pkg.license.type;
+            }
+            else if (Array.isArray(pkg.licenses)) {
+                licenseStr = pkg.licenses.map((l) => l.type || 'UNKNOWN').join(' AND ');
+            }
+            if (!licenseStr)
+                return { license: 'UNKNOWN' };
+            licenseStr = (0, BuiltInLicenseChecker_1.normalizeLicense)(licenseStr);
+            const result = { license: licenseStr };
+            if (this.options.includeLicenseText) {
+                const licenseText = this.readLicenseFileText(pkgInfo.path);
+                if (licenseText) {
+                    result.licenseText = licenseText;
+                }
+            }
+            return result;
+        }
+        catch {
+            return { license: 'UNKNOWN' };
+        }
+    }
+    readLicenseFileText(packageDir) {
+        const basenames = [
+            /^LICENSE$/i, /^LICENSE\-\w+$/i, /^LICENCE$/i, /^LICENCE\-\w+$/i,
+            /^MIT-LICENSE$/i, /^COPYING$/i, /^COPYRIGHT$/i,
+        ];
+        try {
+            const files = (0, fs_1.readdirSync)(packageDir);
+            const candidates = [];
+            for (const file of files) {
+                const fullPath = (0, path_1.join)(packageDir, file);
+                try {
+                    if (!(0, fs_1.statSync)(fullPath).isFile())
+                        continue;
+                }
+                catch {
+                    continue;
+                }
+                for (let i = 0; i < basenames.length; i++) {
+                    if (basenames[i].test(file)) {
+                        candidates.push({ file: fullPath, order: i });
+                        break;
+                    }
+                }
+            }
+            candidates.sort((a, b) => a.order - b.order);
+            if (candidates.length > 0) {
+                return (0, fs_1.readFileSync)(candidates[0].file, 'utf-8');
+            }
+        }
+        catch {
+            // ignore
+        }
+        return undefined;
+    }
     format(items) {
         return this.createFormatter().generate(items);
     }

package/dist/checker/BuiltInLicenseChecker.js

@@ -187,56 +187,66 @@ function parseAuthor(author) {
 }
 async function findPackages(startPath) {
     const packages = [];
-    const nodeModulesPath = path.join(startPath, 'node_modules');
-    try {
-        await (0, promises_1.stat)(nodeModulesPath);
-    }
-    catch {
-        return packages;
-    }
-    try {
-        const entries = await (0, promises_1.readdir)(nodeModulesPath, { withFileTypes: true });
-        for (const entry of entries) {
-            if (!entry.isDirectory())
-                continue;
-            if (entry.name.startsWith('.'))
-                continue;
-            if (entry.name.startsWith('@')) {
-                const scopeDir = path.join(nodeModulesPath, entry.name);
-                try {
-                    const scopeEntries = await (0, promises_1.readdir)(scopeDir, { withFileTypes: true });
-                    for (const scopeEntry of scopeEntries) {
-                        if (!scopeEntry.isDirectory())
-                            continue;
-                        const pkgPath = path.join(scopeDir, scopeEntry.name);
-                        try {
-                            await (0, promises_1.stat)(path.join(pkgPath, 'package.json'));
-                            packages.push(pkgPath);
-                        }
-                        catch {
-                            // Skip packages without package.json
+    const visited = new Set();
+    async function scan(nodeModulesPath) {
+        if (visited.has(nodeModulesPath))
+            return;
+        visited.add(nodeModulesPath);
+        try {
+            await (0, promises_1.stat)(nodeModulesPath);
+        }
+        catch {
+            return;
+        }
+        try {
+            const entries = await (0, promises_1.readdir)(nodeModulesPath, { withFileTypes: true });
+            for (const entry of entries) {
+                if (!entry.isDirectory())
+                    continue;
+                if (entry.name.startsWith('.'))
+                    continue;
+                if (entry.name.startsWith('@')) {
+                    const scopeDir = path.join(nodeModulesPath, entry.name);
+                    try {
+                        const scopeEntries = await (0, promises_1.readdir)(scopeDir, { withFileTypes: true });
+                        for (const scopeEntry of scopeEntries) {
+                            if (!scopeEntry.isDirectory())
+                                continue;
+                            const pkgPath = path.join(scopeDir, scopeEntry.name);
+                            try {
+                                await (0, promises_1.stat)(path.join(pkgPath, 'package.json'));
+                                packages.push(pkgPath);
+                                // Recursively scan nested node_modules
+                                await scan(path.join(pkgPath, 'node_modules'));
+                            }
+                            catch {
+                                // Skip packages without package.json
+                            }
                         }
                     }
+                    catch {
+                        // Ignore errors
+                    }
                 }
-                catch {
-                    // Ignore errors
-                }
-            }
-            else {
-                const pkgPath = path.join(nodeModulesPath, entry.name);
-                try {
-                    await (0, promises_1.stat)(path.join(pkgPath, 'package.json'));
-                    packages.push(pkgPath);
-                }
-                catch {
-                    // Skip packages without package.json
+                else {
+                    const pkgPath = path.join(nodeModulesPath, entry.name);
+                    try {
+                        await (0, promises_1.stat)(path.join(pkgPath, 'package.json'));
+                        packages.push(pkgPath);
+                        // Recursively scan nested node_modules
+                        await scan(path.join(pkgPath, 'node_modules'));
+                    }
+                    catch {
+                        // Skip packages without package.json
+                    }
                 }
             }
         }
+        catch {
+            // Ignore errors
+        }
     }
-    catch {
-        // Ignore errors
-    }
+    await scan(path.join(startPath, 'node_modules'));
     return packages;
 }
 async function processPackage(packagePath, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "license-checker-plugin",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A bundler-agnostic plugin to generate third-party license notices for bundled packages. Supports webpack 5, Rspack, and Vite.",
   "author": "Axetroy <axetroy.dev@gmail.com>",
   "repository": {

package/dist/utils/fs.d.ts

@@ -1,3 +0,0 @@
-export declare function readFileIfExists(filePath: string): string | null;
-export declare function readJsonFile(filePath: string): Record<string, unknown> | null;
-export declare function findFileInDir(dir: string, filename: string): string | null;

package/dist/utils/fs.js

@@ -1,61 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readFileIfExists = readFileIfExists;
-exports.readJsonFile = readJsonFile;
-exports.findFileInDir = findFileInDir;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-function readFileIfExists(filePath) {
-    try {
-        return fs.readFileSync(filePath, 'utf-8');
-    }
-    catch (_a) {
-        return null;
-    }
-}
-function readJsonFile(filePath) {
-    try {
-        const content = fs.readFileSync(filePath, 'utf-8');
-        return JSON.parse(content);
-    }
-    catch (_a) {
-        return null;
-    }
-}
-function findFileInDir(dir, filename) {
-    const filePath = path.join(dir, filename);
-    return fs.existsSync(filePath) ? filePath : null;
-}

package/dist/utils/hash.d.ts

@@ -1 +0,0 @@
-export declare function hashString(str: string): string;

package/dist/utils/hash.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hashString = hashString;
-const crypto_1 = require("crypto");
-function hashString(str) {
-    return (0, crypto_1.createHash)('md5').update(str).digest('hex');
-}

package/dist/utils/path.d.ts

@@ -1,3 +0,0 @@
-export declare function findPackageRoot(modulePath: string): string | null;
-export declare function isNodeModule(filePath: string): boolean;
-export declare function getNodeModuleName(filePath: string): string | null;

package/dist/utils/path.js

@@ -1,64 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findPackageRoot = findPackageRoot;
-exports.isNodeModule = isNodeModule;
-exports.getNodeModuleName = getNodeModuleName;
-const path = __importStar(require("path"));
-const fs_1 = require("./fs");
-function findPackageRoot(modulePath) {
-    let dir = path.dirname(modulePath);
-    const root = path.parse(dir).root;
-    while (dir !== root) {
-        const pkgJsonPath = path.join(dir, 'package.json');
-        const pkg = (0, fs_1.readJsonFile)(pkgJsonPath);
-        if (pkg && typeof pkg.name === 'string' && dir.includes('node_modules')) {
-            return dir;
-        }
-        const parent = path.dirname(dir);
-        if (parent === dir) {
-            break;
-        }
-        dir = parent;
-    }
-    return null;
-}
-function isNodeModule(filePath) {
-    return filePath.includes('node_modules');
-}
-function getNodeModuleName(filePath) {
-    const match = filePath.match(/node_modules[\\/]((?:@[^\\/]+[\\/])?[^\\/]+)/);
-    return match ? match[1] : null;
-}