@node-cli/bundlecheck 1.2.0 → 1.4.0

package/dist/bundler.js

@@ -8,12 +8,12 @@ import * as esbuild from "esbuild";
 import { DEFAULT_EXTERNALS } from "./defaults.js";
 const gzipAsync = promisify(zlib.gzip);
 /**
- * Escape special regex characters in a string
+ * Escape special regex characters in a string.
  */ function escapeRegExp(str) {
     return str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 /**
- * Parse a package specifier to extract name, version, and subpath
+ * Parse a package specifier to extract name, version, and subpath.
  * Handles:
  * - @scope/package@1.0.0
  * - @scope/package/subpath@1.0.0
@@ -24,17 +24,18 @@ const gzipAsync = promisify(zlib.gzip);
     let version = "latest";
     // Handle scoped packages (@scope/name...)
     if (workingSpec.startsWith("@")) {
-        // Find the second @ which would separate version
+        // Find the second @ which would separate version.
         const secondAtIndex = workingSpec.indexOf("@", 1);
         if (secondAtIndex !== -1) {
             version = workingSpec.substring(secondAtIndex + 1);
             workingSpec = workingSpec.substring(0, secondAtIndex);
         }
-        // Now workingSpec is like @scope/name or @scope/name/subpath
-        // Split by / and check if there are more than 2 parts
-        const parts = workingSpec.split("/");
+        /**
+		 * Now workingSpec is like @scope/name or @scope/name/subpath Split by / and
+		 * check if there are more than 2 parts.
+		 */ const parts = workingSpec.split("/");
         if (parts.length > 2) {
-            // Has subpath: @scope/name/subpath/more
+            // Has subpath: @scope/name/subpath/more.
             const name = `${parts[0]}/${parts[1]}`;
             const subpath = parts.slice(2).join("/");
             return {
@@ -43,19 +44,19 @@ const gzipAsync = promisify(zlib.gzip);
                 subpath
             };
         }
-        // No subpath: @scope/name
+        // No subpath: @scope/name.
         return {
             name: workingSpec,
             version
         };
     }
-    // Handle non-scoped packages (name@version or name/subpath@version)
+    // Handle non-scoped packages (name@version or name/subpath@version).
     const atIndex = workingSpec.indexOf("@");
     if (atIndex !== -1) {
         version = workingSpec.substring(atIndex + 1);
         workingSpec = workingSpec.substring(0, atIndex);
     }
-    // Check for subpath in non-scoped packages
+    // Check for subpath in non-scoped packages.
     const slashIndex = workingSpec.indexOf("/");
     if (slashIndex !== -1) {
         const name = workingSpec.substring(0, slashIndex);
@@ -72,7 +73,7 @@ const gzipAsync = promisify(zlib.gzip);
     };
 }
 /**
- * Format bytes to human-readable string
+ * Format bytes to human-readable string.
  */ export function formatBytes(bytes) {
     if (bytes === 0) {
         return "0 B";
@@ -88,7 +89,7 @@ const gzipAsync = promisify(zlib.gzip);
     return `${Number.parseFloat((bytes / k ** i).toFixed(2))} ${sizes[i]}`;
 }
 /**
- * Create a temporary directory for bundling
+ * Create a temporary directory for bundling.
  */ function createTempDir() {
     const tmpDir = path.join(os.tmpdir(), `bundlecheck-${Date.now()}`);
     fs.mkdirSync(tmpDir, {
@@ -97,7 +98,7 @@ const gzipAsync = promisify(zlib.gzip);
     return tmpDir;
 }
 /**
- * Clean up temporary directory
+ * Clean up temporary directory.
  */ function cleanupTempDir(tmpDir) {
     try {
         fs.rmSync(tmpDir, {
@@ -105,11 +106,11 @@ const gzipAsync = promisify(zlib.gzip);
             force: true
         });
     } catch  {
-    // Ignore cleanup errors
+    // Ignore cleanup errors.
     }
 }
 /**
- * Check if pnpm is available
+ * Check if pnpm is available.
  */ function isPnpmAvailable() {
     try {
         execSync("pnpm --version", {
@@ -120,30 +121,30 @@ const gzipAsync = promisify(zlib.gzip);
         return false;
     }
 }
-// Cache the result of pnpm availability check
+// Cache the result of pnpm availability check.
 let usePnpm = null;
 /**
- * Validate and sanitize a registry URL to prevent command injection
+ * Validate and sanitize a registry URL to prevent command injection.
  * @param registry - The registry URL to validate
  * @returns The sanitized URL or undefined if invalid
  * @throws Error if the URL is invalid or contains potentially malicious characters
  */ function validateRegistryUrl(registry) {
-    // Parse as URL to validate format
+    // Parse as URL to validate format.
     let url;
     try {
         url = new URL(registry);
     } catch  {
         throw new Error(`Invalid registry URL: ${registry}. Must be a valid URL (e.g., https://registry.example.com)`);
     }
-    // Only allow http and https protocols
+    // Only allow http and https protocols.
     if (url.protocol !== "http:" && url.protocol !== "https:") {
         throw new Error(`Invalid registry URL protocol: ${url.protocol}. Only http: and https: are allowed`);
     }
-    // Return the sanitized URL (URL constructor normalizes it)
+    // Return the sanitized URL (URL constructor normalizes it).
     return url.toString();
 }
 /**
- * Get the install command (pnpm preferred, npm fallback)
+ * Get the install command (pnpm preferred, npm fallback).
  * @param registry - Optional custom npm registry URL
  */ function getInstallCommand(registry) {
     if (usePnpm === null) {
@@ -151,9 +152,9 @@ let usePnpm = null;
     }
     let registryArg = "";
     if (registry) {
-        // Validate and sanitize the registry URL to prevent command injection
+        // Validate and sanitize the registry URL to prevent command injection.
         const sanitizedRegistry = validateRegistryUrl(registry);
-        // Quote the URL to handle any special characters safely
+        // Quote the URL to handle any special characters safely.
         registryArg = ` --registry "${sanitizedRegistry}"`;
     }
     if (usePnpm) {
@@ -162,19 +163,19 @@ let usePnpm = null;
     return `npm install --legacy-peer-deps --ignore-scripts${registryArg}`;
 }
 /**
- * Generate the entry file content based on package, subpath, and exports
+ * Generate the entry file content based on package, subpath, and exports.
  */ function generateEntryContent(options) {
     const { packageName, subpath, exports, allSubpaths, exportToSubpath } = options;
-    // If we have exports mapped to different subpaths
+    // If we have exports mapped to different subpaths.
     if (exportToSubpath && exportToSubpath.size > 0) {
-        // Group exports by subpath
+        // Group exports by subpath.
         const subpathToExports = new Map();
         for (const [exportName, sp] of exportToSubpath){
             const existing = subpathToExports.get(sp) || [];
             existing.push(exportName);
             subpathToExports.set(sp, existing);
         }
-        // Generate imports for each subpath
+        // Generate imports for each subpath.
         const lines = [];
         const allExportNames = [];
         for (const [sp, exportNames] of subpathToExports){
@@ -186,43 +187,43 @@ let usePnpm = null;
         lines.push(`export { ${allExportNames.join(", ")} };`);
         return lines.join("\n") + "\n";
     }
-    // If we have specific exports to import
+    // If we have specific exports to import.
     if (exports && exports.length > 0) {
-        // Determine the import path
+        // Determine the import path.
         const importPath = subpath ? `${packageName}/${subpath}` : packageName;
         const importNames = exports.join(", ");
         return `import { ${importNames} } from "${importPath}";\nexport { ${importNames} };\n`;
     }
-    // If we have a specific subpath (but no specific exports)
+    // If we have a specific subpath (but no specific exports).
     if (subpath) {
         const importPath = `${packageName}/${subpath}`;
         return `import * as pkg from "${importPath}";\nexport default pkg;\n`;
     }
-    // If package has subpath exports only (no main entry), import all subpaths
+    // If package has subpath exports only (no main entry), import all subpaths.
     if (allSubpaths && allSubpaths.length > 0) {
         const imports = allSubpaths.map((sp, i)=>`import * as sub${i} from "${packageName}/${sp}";\nexport { sub${i} };`).join("\n");
         return imports + "\n";
     }
-    // Default: import everything from main entry
+    // Default: import everything from main entry.
     return `import * as pkg from "${packageName}";\nexport default pkg;\n`;
 }
 /**
- * Get externals list based on options
- */ function getExternals(packageName, externals, noExternal) {
+ * Get externals list based on options.
+ */ export function getExternals(packageName, externals, noExternal) {
     if (noExternal) {
         return [];
     }
-    // Start with default externals (react, react-dom)
+    // Start with default externals (react, react-dom).
     let result = [
         ...DEFAULT_EXTERNALS
     ];
-    // If checking react or react-dom themselves, don't mark them as external
+    // If checking react or react-dom themselves, don't mark them as external.
     if (packageName === "react") {
         result = result.filter((e)=>e !== "react");
     } else if (packageName === "react-dom") {
         result = result.filter((e)=>e !== "react-dom");
     }
-    // Add any additional externals
+    // Add any additional externals.
     if (externals && externals.length > 0) {
         result = [
             ...new Set([
@@ -234,48 +235,51 @@ let usePnpm = null;
     return result;
 }
 /**
- * Get version, dependencies, peer dependencies, and exports from an installed package
+ * Get version, dependencies, peer dependencies, and exports from an installed
+ * package.
  */ function getPackageInfo(tmpDir, packageName) {
     try {
-        // Handle scoped packages - the package name in node_modules
+        // Handle scoped packages - the package name in node_modules.
         const pkgJsonPath = path.join(tmpDir, "node_modules", packageName, "package.json");
         if (fs.existsSync(pkgJsonPath)) {
             const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
-            // Check if package has a main entry point
+            // Check if package has a main entry point.
             const hasMainEntry = Boolean(pkgJson.main || pkgJson.module || pkgJson.exports?.["."] || pkgJson.exports?.["./index"] || !pkgJson.exports && !pkgJson.main && !pkgJson.module);
             return {
                 version: pkgJson.version || "unknown",
                 dependencies: pkgJson.dependencies || {},
                 peerDependencies: pkgJson.peerDependencies || {},
                 exports: pkgJson.exports || null,
-                hasMainEntry
+                hasMainEntry,
+                engines: pkgJson.engines || null
             };
         }
     } catch  {
-    // Ignore errors reading package info
+    // Ignore errors reading package info.
     }
     return {
         version: "unknown",
         dependencies: {},
         peerDependencies: {},
         exports: null,
-        hasMainEntry: true
+        hasMainEntry: true,
+        engines: null
     };
 }
 /**
- * Extract subpath export names from package exports field
- * Returns array of subpaths like ["header", "body", "datagrid"]
+ * Extract subpath export names from package exports field Returns array of
+ * subpaths like ["header", "body", "datagrid"].
  */ function getSubpathExports(exports) {
     if (!exports) {
         return [];
     }
     const subpaths = [];
     for (const key of Object.keys(exports)){
-        // Skip the main entry point and package.json
+        // Skip the main entry point and package.json.
         if (key === "." || key === "./package.json") {
             continue;
         }
-        // Remove leading "./" to get subpath name
+        // Remove leading "./" to get subpath name.
         if (key.startsWith("./")) {
             subpaths.push(key.substring(2));
         }
@@ -283,20 +287,20 @@ let usePnpm = null;
     return subpaths;
 }
 /**
- * Find which subpath(s) export the given component names
- * Reads type definition files or JS files to find the exports
+ * Find which subpath(s) export the given component names Reads type definition
+ * files or JS files to find the exports.
  */ function findSubpathsForExports(tmpDir, packageName, exports, componentNames) {
     const packageDir = path.join(tmpDir, "node_modules", packageName);
     const exportToSubpath = new Map();
     for (const [subpathKey, subpathValue] of Object.entries(exports)){
-        // Skip main entry and package.json
+        // Skip main entry and package.json.
         if (subpathKey === "." || subpathKey === "./package.json") {
             continue;
         }
-        // Get the types or import path
+        // Get the types or import path.
         let filePath;
         if (typeof subpathValue === "object" && subpathValue !== null) {
-            // Prefer types file for more accurate export detection
+            // Prefer types file for more accurate export detection.
             filePath = subpathValue.types || subpathValue.import;
         } else if (typeof subpathValue === "string") {
             filePath = subpathValue;
@@ -304,21 +308,21 @@ let usePnpm = null;
         if (!filePath) {
             continue;
         }
-        // Resolve the file path
+        // Resolve the file path.
         const fullPath = path.join(packageDir, filePath);
         try {
             if (fs.existsSync(fullPath)) {
                 const content = fs.readFileSync(fullPath, "utf-8");
                 const subpath = subpathKey.startsWith("./") ? subpathKey.substring(2) : subpathKey;
-                // Check each component name
+                // Check each component name.
                 for (const name of componentNames){
-                    // Skip if already found
+                    // Skip if already found.
                     if (exportToSubpath.has(name)) {
                         continue;
                     }
-                    // Escape regex special characters in the name to prevent injection
+                    // Escape regex special characters in the name to prevent injection.
                     const escapedName = escapeRegExp(name);
-                    // Look for various export patterns
+                    // Look for various export patterns.
                     const patterns = [
                         new RegExp(`export\\s*\\{[^}]*\\b${escapedName}\\b[^}]*\\}`, "m"),
                         new RegExp(`export\\s+declare\\s+(?:const|function|class)\\s+${escapedName}\\b`, "m"),
@@ -330,14 +334,14 @@ let usePnpm = null;
                 }
             }
         } catch  {
-        // Ignore read errors, continue to next subpath
+        // Ignore read errors, continue to next subpath.
         }
     }
-    // Check if all exports were found
+    // Check if all exports were found.
     if (exportToSubpath.size !== componentNames.length) {
         return {}; // Not all exports found
     }
-    // Check if all exports are from the same subpath
+    // Check if all exports are from the same subpath.
     const subpaths = new Set(exportToSubpath.values());
     if (subpaths.size === 1) {
         return {
@@ -346,20 +350,20 @@ let usePnpm = null;
             ][0]
         };
     }
-    // Multiple subpaths needed
+    // Multiple subpaths needed.
     return {
         exportToSubpath
     };
 }
 /**
- * Check the bundle size of an npm package
+ * Check the bundle size of an npm package.
  */ export async function checkBundleSize(options) {
-    const { packageName: packageSpecifier, exports, additionalExternals, noExternal, gzipLevel = 5, registry } = options;
-    // Parse the package specifier to extract name, version, and subpath
+    const { packageName: packageSpecifier, exports, additionalExternals, noExternal, gzipLevel = 5, registry, platform: explicitPlatform } = options;
+    // Parse the package specifier to extract name, version, and subpath.
     const { name: packageName, version: requestedVersion, subpath } = parsePackageSpecifier(packageSpecifier);
     const tmpDir = createTempDir();
     try {
-        // Create initial package.json
+        // Create initial package.json.
         const packageJson = {
             name: "bundlecheck-temp",
             version: "1.0.0",
@@ -369,16 +373,28 @@ let usePnpm = null;
             }
         };
         fs.writeFileSync(path.join(tmpDir, "package.json"), JSON.stringify(packageJson, null, 2));
-        // Install the main package (try pnpm first, fallback to npm)
+        // Install the main package (try pnpm first, fallback to npm).
         const installCmd = getInstallCommand(registry);
         execSync(installCmd, {
             cwd: tmpDir,
             stdio: "pipe"
         });
-        // Get package info (version, dependencies, peer dependencies, exports)
-        const pkgInfo = getPackageInfo(tmpDir, packageName);
+        /**
+		 * Get package info (version, dependencies, peer dependencies, exports,
+		 * engines).
+		 */ const pkgInfo = getPackageInfo(tmpDir, packageName);
         const peerDepKeys = Object.keys(pkgInfo.peerDependencies);
-        // Collect all dependency names (prod + peer)
+        /**
+		 * Determine platform: use explicit value if provided, otherwise auto-detect
+		 * from engines.
+		 */ let platform = "browser";
+        if (explicitPlatform) {
+            platform = explicitPlatform;
+        } else if (pkgInfo.engines?.node && !pkgInfo.engines?.browser) {
+            // Package specifies node engine without browser - likely a Node.js package.
+            platform = "node";
+        }
+        // Collect all dependency names (prod + peer).
         const allDependencies = [
             ...new Set([
                 ...Object.keys(pkgInfo.dependencies),
@@ -386,40 +402,42 @@ let usePnpm = null;
             ])
         ].sort();
         if (peerDepKeys.length > 0) {
-            // Add peer dependencies to package.json
+            // Add peer dependencies to package.json.
             for (const dep of peerDepKeys){
-                // Use the version range from peer dependencies
+                // Use the version range from peer dependencies.
                 packageJson.dependencies[dep] = pkgInfo.peerDependencies[dep];
             }
-            // Update package.json and reinstall
+            // Update package.json and reinstall.
             fs.writeFileSync(path.join(tmpDir, "package.json"), JSON.stringify(packageJson, null, 2));
             execSync(installCmd, {
                 cwd: tmpDir,
                 stdio: "pipe"
             });
         }
-        // Determine if we need to use all subpath exports or find the right subpath(s)
-        let allSubpaths;
+        /**
+		 * Determine if we need to use all subpath exports or find the right
+		 * subpath(s).
+		 */ let allSubpaths;
         let resolvedSubpath = subpath;
         let exportToSubpath;
         if (!subpath && !pkgInfo.hasMainEntry && pkgInfo.exports) {
             if (exports && exports.length > 0) {
-                // User specified exports but no subpath - try to find the right subpath(s)
+                // User specified exports but no subpath - try to find the right subpath(s).
                 const mapping = findSubpathsForExports(tmpDir, packageName, pkgInfo.exports, exports);
                 if (mapping.singleSubpath) {
-                    // All exports from the same subpath
+                    // All exports from the same subpath.
                     resolvedSubpath = mapping.singleSubpath;
                 } else if (mapping.exportToSubpath) {
-                    // Exports from multiple subpaths
+                    // Exports from multiple subpaths.
                     exportToSubpath = mapping.exportToSubpath;
                 }
             }
-            // If still no subpath resolved and no mapping, bundle all subpaths
+            // If still no subpath resolved and no mapping, bundle all subpaths.
             if (!resolvedSubpath && !exportToSubpath) {
                 allSubpaths = getSubpathExports(pkgInfo.exports);
             }
         }
-        // Create entry file with appropriate content
+        // Create entry file with appropriate content.
         const entryContent = generateEntryContent({
             packageName,
             subpath: resolvedSubpath,
@@ -429,9 +447,9 @@ let usePnpm = null;
         });
         const entryFile = path.join(tmpDir, "entry.js");
         fs.writeFileSync(entryFile, entryContent);
-        // Get externals
+        // Get externals.
         const externals = getExternals(packageName, additionalExternals, noExternal);
-        // Bundle with esbuild
+        // Bundle with esbuild.
         const result = await esbuild.build({
             entryPoints: [
                 entryFile
@@ -439,27 +457,30 @@ let usePnpm = null;
             bundle: true,
             write: false,
             format: "esm",
-            platform: "browser",
+            platform,
             target: "es2020",
             minify: true,
             treeShaking: true,
             external: externals,
             metafile: true
         });
-        // Get raw size
+        // Get raw size.
         const bundleContent = result.outputFiles[0].contents;
         const rawSize = bundleContent.length;
-        // Gzip the bundle
-        const gzipped = await gzipAsync(Buffer.from(bundleContent), {
-            level: gzipLevel
-        });
-        const gzipSize = gzipped.length;
-        // Determine the display name
+        // Gzip the bundle (only for browser platform - not relevant for Node.js).
+        let gzipSize = null;
+        if (platform === "browser") {
+            const gzipped = await gzipAsync(Buffer.from(bundleContent), {
+                level: gzipLevel
+            });
+            gzipSize = gzipped.length;
+        }
+        // Determine the display name.
         let displayName = packageName;
         if (resolvedSubpath) {
             displayName = `${packageName}/${resolvedSubpath}`;
         } else if (exportToSubpath && exportToSubpath.size > 0) {
-            // Multiple subpaths - show them all
+            // Multiple subpaths - show them all.
             const uniqueSubpaths = [
                 ...new Set(exportToSubpath.values())
             ].sort();
@@ -473,7 +494,8 @@ let usePnpm = null;
             gzipSize,
             gzipLevel,
             externals,
-            dependencies: allDependencies
+            dependencies: allDependencies,
+            platform
         };
     } finally{
         cleanupTempDir(tmpDir);