bunchee 5.0.0-beta.1 → 5.0.0-beta.3

package/README.md

@@ -14,7 +14,7 @@
   </a>
 </p>
 
-Bunchee makes bundling your library into one file effortless, with zero configuration required. It is built on top of Rollup and SWC ⚡️, allowing you to focus on writing code and generating multiple module types (CommonJS, ESModules) simultaneously.
+**bunchee** is a zero configuration bundler makes bundling JS/tS library effortless. It's built on top of Rollup and SWC ⚡️, allowing you to focus on writing code and generating multiple bundles (CommonJS or ESModule) at the same time.
 It uses the standard exports configuration in `package.json` as the only source of truth, and uses entry file conventions to match your exports and build them into bundles.
 
 ## Quick Start
@@ -44,7 +44,7 @@ mkdir src && touch ./src/index.ts
 
 ```sh
 # Use bunchee to prepare package.json configuration
-npm bunchee --prepare
+npm exec bunchee --prepare
 # "If you're using other package manager such as pnpm"
 # pnpm bunchee --prepare
 
@@ -252,6 +252,63 @@ Then when the library is integrated to an app such as Next.js, app bundler can t
 If you're using `"use client"` or `"use server"` in entry file, then it will be preserved on top and the dist file of that entry will become a client component.
 If you're using `"use client"` or `"use server"` in a file that used as a dependency for an entry, then that file containing directives be split into a separate chunk and hoist the directives to the top of the chunk.
 
+### Shared Modules
+
+There're always cases that you need to share code among bundles but they don't have to be a separate entry or exports. You want to have them bundled into a shared chunk and then use them in different bundles. You can use shared module convention `[name].[layer]-runtime.[ext]` to create shared modules bundles.
+
+<details>
+  <summary>Shared Utils Example</summary>
+
+```js
+// src/util.shared-runtime.js
+export function sharedUtil() {
+  /* ... */
+}
+```
+
+Then you can use them in different entry files:
+
+```js
+// src/index.js
+import { sharedUtil } from './util.shared-runtime'
+```
+
+```js
+// src/lite.js
+import { sharedUtil } from './util.shared-runtime'
+```
+
+`bunchee` will bundle the shared module into a separate **layer** which matches the file name convention, in the above case it's "shared", and that bundle will be referenced by the different entry bundles.
+
+</details>
+
+With multiple runtime bundles, such as having `default` and `react-server` together. They could have the modules that need to be shared and kept as only one instance among different runtime bundles. You can use the shared module convention to create shared modules bundles for different runtime bundles.
+
+<details>
+  <summary>Shared Runtime Module Example</summary>
+
+```js
+'use client'
+// src/app-context.shared-runtime.js
+export const AppContext = React.createContext(null)
+```
+
+Then you can use them in different entry files:
+
+```js
+// src/index.js
+import { AppContext } from './app-context.shared-runtime'
+```
+
+```js
+// src/index.react-server.js
+import { AppContext } from './app-context.shared-runtime'
+```
+
+`app-context.shared-runtime` will be bundled into a separate chunk that only has one instance and be shared among different runtime bundles.
+
+</details>
+
 ### CLI
 
 #### CLI Options

package/dist/bin/cli.js

@@ -189,9 +189,10 @@ function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exp
     // End of searching, export value is file path.
     // <export key>: <export value> (string)
     if (typeof exportValue === 'string') {
-        exportTypes.add(exportKey.startsWith('./') ? 'default' : exportKey);
+        const composedTypes = new Set(exportTypes);
+        composedTypes.add(exportKey.startsWith('.') ? 'default' : exportKey);
         const exportInfo = exportToDist.get(currentPath);
-        const exportCondition = Array.from(exportTypes).join('.');
+        const exportCondition = Array.from(composedTypes).join('.');
         if (!exportInfo) {
             const outputConditionPair = [
                 exportValue,
@@ -254,6 +255,9 @@ function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exp
             const exportTypes = new Set();
             const isExportPath = exportKey.startsWith('.');
             const childPath = isExportPath ? joinRelativePath(currentPath, exportKey) : currentPath;
+            if (!isExportPath) {
+                exportTypes.add(exportKey);
+            }
             collectExportPath(exportValue, exportKey, childPath, exportTypes, exportToDist);
         }
     }
@@ -279,14 +283,15 @@ function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exp
             ]);
         }
     }
-    if (pkg.main || pkg.module) {
+    // Handle package.json global exports fields
+    if (pkg.main || pkg.module || pkg.types) {
         const mainExportPath = pkg.main;
         const moduleExportPath = pkg.module;
         const typesEntryPath = pkg.types;
         const existingExportInfo = exportToDist.get('.');
         exportToDist.set('.', [
             ...existingExportInfo || [],
-            [
+            Boolean(mainExportPath) && [
                 mainExportPath,
                 getMainFieldExportType(pkg)
             ],
@@ -345,8 +350,7 @@ function lint$1(pkg) {
                 if (hasCjsExtension(exports)) {
                     state.badMainExport = true;
                 }
-            }
-            if (typeof exports !== 'object') {
+            } else if (typeof exports !== 'object') {
                 state.invalidExportsFieldType = true;
             } else {
                 parsedExports.forEach((outputPairs)=>{
@@ -384,8 +388,7 @@ function lint$1(pkg) {
                 if (path__default.default.extname(exports) === '.mjs') {
                     state.badMainExport = true;
                 }
-            }
-            if (typeof exports !== 'object') {
+            } else if (typeof exports !== 'object') {
                 state.invalidExportsFieldType = true;
             } else {
                 parsedExports.forEach((outputPairs)=>{
@@ -453,7 +456,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "5.0.0-beta.1";
+var version = "5.0.0-beta.3";
 
 function relativify(path) {
     return path.startsWith('.') ? path : `./${path}`;
@@ -495,7 +498,7 @@ function getExportTypeFromExportTypes(types) {
     new Set(types).forEach((value)=>{
         if (specialExportConventions.has(value)) {
             exportType = value;
-        } else if (value === 'import' || value === 'require') {
+        } else if (value === 'import' || value === 'require' || value === 'types') {
             exportType = value;
         }
     });

package/dist/index.js

@@ -601,9 +601,10 @@ function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exp
     // End of searching, export value is file path.
     // <export key>: <export value> (string)
     if (typeof exportValue === 'string') {
-        exportTypes.add(exportKey.startsWith('./') ? 'default' : exportKey);
+        const composedTypes = new Set(exportTypes);
+        composedTypes.add(exportKey.startsWith('.') ? 'default' : exportKey);
         const exportInfo = exportToDist.get(currentPath);
-        const exportCondition = Array.from(exportTypes).join('.');
+        const exportCondition = Array.from(composedTypes).join('.');
         if (!exportInfo) {
             const outputConditionPair = [
                 exportValue,
@@ -666,6 +667,9 @@ function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exp
             const exportTypes = new Set();
             const isExportPath = exportKey.startsWith('.');
             const childPath = isExportPath ? joinRelativePath(currentPath, exportKey) : currentPath;
+            if (!isExportPath) {
+                exportTypes.add(exportKey);
+            }
             collectExportPath(exportValue, exportKey, childPath, exportTypes, exportToDist);
         }
     }
@@ -691,14 +695,15 @@ function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exp
             ]);
         }
     }
-    if (pkg.main || pkg.module) {
+    // Handle package.json global exports fields
+    if (pkg.main || pkg.module || pkg.types) {
         const mainExportPath = pkg.main;
         const moduleExportPath = pkg.module;
         const typesEntryPath = pkg.types;
         const existingExportInfo = exportToDist.get('.');
         exportToDist.set('.', [
             ...existingExportInfo || [],
-            [
+            Boolean(mainExportPath) && [
                 mainExportPath,
                 getMainFieldExportType(pkg)
             ],
@@ -729,12 +734,21 @@ function isCjsExportName(pkg, exportCondition, ext) {
     const isNotEsmExportName = !isEsmExportName(exportCondition, ext);
     return !isESModule && isNotEsmExportName && (ext !== 'mjs' || isCjsCondition) || ext === 'cjs';
 }
-function getExportsDistFilesOfCondition(pkg, parsedExportCondition, cwd) {
+function getFileExportType(composedTypes) {
+    return composedTypes.split('.').pop();
+}
+function getExportsDistFilesOfCondition(pkg, parsedExportCondition, cwd, dts) {
     const dist = [];
     const exportConditionNames = Object.keys(parsedExportCondition.export);
     const uniqueFiles = new Set();
     for (const exportCondition of exportConditionNames){
-        if (exportCondition === 'types') {
+        const exportType = getFileExportType(exportCondition);
+        // Filter out non-types field when generating types jobs
+        if (dts && exportType !== 'types') {
+            continue;
+        }
+        // Filter out types field when generating asset jobs
+        if (!dts && exportType === 'types') {
             continue;
         }
         const filePath = parsedExportCondition.export[exportCondition];
@@ -911,7 +925,7 @@ function getExportTypeFromExportTypes(types) {
     new Set(types).forEach((value)=>{
         if (specialExportConventions.has(value)) {
             exportType = value;
-        } else if (value === 'import' || value === 'require') {
+        } else if (value === 'import' || value === 'require' || value === 'types') {
             exportType = value;
         }
     });
@@ -1018,7 +1032,9 @@ async function collectSourceEntries(sourceFolderPath) {
 }
 
 const swcMinifyOptions = {
-    compress: true,
+    compress: {
+        directives: false
+    },
     format: {
         comments: 'some'
     },
@@ -1189,7 +1205,7 @@ async function buildInputConfig(entry, bundleConfig, exportCondition, buildConte
             if (dts && code === 'EMPTY_BUNDLE') return;
             if (disabledWarnings.has(code)) return;
             // If the circular dependency warning is from node_modules, ignore it
-            if (code === 'CIRCULAR_DEPENDENCY' && /Circular dependency: node_modules/.test(warning.message)) {
+            if (code === 'CIRCULAR_DEPENDENCY' && /Circular dependency:(\s|\S)*node_modules/.test(warning.message)) {
                 return;
             }
             warn(warning);
@@ -1203,6 +1219,19 @@ function getModuleLater(moduleMeta) {
     const moduleLayer = directives[0];
     return moduleLayer;
 }
+function getCustomModuleLayer(moduleId) {
+    const segments = path__default.default.basename(moduleId).split('.');
+    if (segments.length >= 2) {
+        const [layerSegment, ext] = segments.slice(-2);
+        const baseName = segments[0];
+        const match = layerSegment.match(/^(\w+)-runtime$/);
+        const layer = match && match[1];
+        if (availableExtensions.has(ext) && layer && layer.length > 0) {
+            return baseName + '-' + layer;
+        }
+    }
+    return undefined;
+}
 // dependencyGraphMap: Map<subModuleId, Set<entryParentId>>
 function createSplitChunks(dependencyGraphMap, entryFiles) {
     // If there's existing chunk being splitted, and contains a layer { <id>: <chunkGroup> }
@@ -1215,6 +1244,15 @@ function createSplitChunks(dependencyGraphMap, entryFiles) {
         const { isEntry } = moduleInfo;
         const moduleMeta = moduleInfo.meta;
         const moduleLayer = getModuleLater(moduleMeta);
+        if (!isEntry) {
+            const cachedCustomModuleLayer = splitChunksGroupMap.get(id);
+            if (cachedCustomModuleLayer) return cachedCustomModuleLayer;
+            const customModuleLayer = getCustomModuleLayer(id);
+            if (customModuleLayer) {
+                splitChunksGroupMap.set(id, customModuleLayer);
+                return customModuleLayer;
+            }
+        }
         // Collect the sub modules of the entry, if they're having layer, and the same layer with the entry, push them to the dependencyGraphMap.
         if (isEntry) {
             const subModuleIds = ctx.getModuleIds();
@@ -1323,7 +1361,7 @@ async function buildConfig(bundleConfig, exportCondition, pluginContext, dts) {
     const { file } = bundleConfig;
     const { pkg, cwd } = pluginContext;
     const entry = exportCondition.source;
-    const outputExports = getExportsDistFilesOfCondition(pkg, exportCondition, cwd);
+    const outputExports = getExportsDistFilesOfCondition(pkg, exportCondition, cwd, dts);
     // If there's nothing found, give a default output
     if (outputExports.length === 0 && !pkg.bin) {
         const isEsmPkg = isESModulePackage(pkg.type);
@@ -1335,44 +1373,52 @@ async function buildConfig(bundleConfig, exportCondition, pluginContext, dts) {
         });
     }
     let bundleOptions = [];
-    // multi outputs with specified format
-    // CLI output option is always prioritized
     if (file) {
-        const fallbackExport = outputExports[0];
-        bundleOptions = [
-            {
-                file: path.resolve(cwd, file),
-                format: bundleConfig.format || fallbackExport.format,
-                exportCondition: fallbackExport.exportCondition
-            }
-        ];
+        const absoluteFile = path.resolve(cwd, file);
+        const absoluteTypeFile = getExportFileTypePath(absoluteFile);
+        if (dts) {
+            bundleOptions = [
+                {
+                    file: absoluteTypeFile,
+                    format: 'esm',
+                    exportCondition: 'types'
+                }
+            ];
+        } else {
+            const fallbackExport = outputExports[0];
+            bundleOptions = [
+                {
+                    file: absoluteFile,
+                    format: bundleConfig.format || fallbackExport.format,
+                    exportCondition: fallbackExport.exportCondition
+                }
+            ];
+        }
     } else {
-        bundleOptions = outputExports.map((exportDist)=>{
-            return {
-                file: path.resolve(cwd, exportDist.file),
-                format: exportDist.format,
-                exportCondition: exportDist.exportCondition
-            };
-        });
-    }
-    if (dts) {
-        // types could have duplicates, dedupe them
-        // e.g. { types, import, .. } use the same `types` condition with all conditions
-        const uniqTypes = new Set();
-        bundleOptions.forEach((bundleOption)=>{
-            if (exportCondition.export.types) {
-                uniqTypes.add(path.resolve(cwd, exportCondition.export.types));
-            }
-            const typeForExtension = getExportFileTypePath(bundleOption.file);
-            uniqTypes.add(typeForExtension);
-        });
-        bundleOptions = Array.from(uniqTypes).map((typeFile)=>{
-            return {
-                file: typeFile,
-                format: 'esm',
-                exportCondition: 'types'
-            };
-        });
+        // CLI output option is always prioritized
+        if (dts) {
+            // types could have duplicates, dedupe them
+            // e.g. { types, import, .. } use the same `types` condition with all conditions
+            const uniqTypes = new Set();
+            outputExports.forEach((exportDist)=>{
+                uniqTypes.add(path.resolve(cwd, exportDist.file));
+            });
+            bundleOptions = Array.from(uniqTypes).map((typeFile)=>{
+                return {
+                    file: typeFile,
+                    format: 'esm',
+                    exportCondition: 'types'
+                };
+            });
+        } else {
+            bundleOptions = outputExports.map((exportDist)=>{
+                return {
+                    file: path.resolve(cwd, exportDist.file),
+                    format: exportDist.format,
+                    exportCondition: exportDist.exportCondition
+                };
+            });
+        }
     }
     const outputConfigs = bundleOptions.map(async (bundleOption)=>{
         const targetExportCondition = {
@@ -1394,17 +1440,21 @@ async function buildConfig(bundleConfig, exportCondition, pluginContext, dts) {
 const removeScope = (exportPath)=>exportPath.replace(/^@[^/]+\//, '');
 function createOutputState({ entries }) {
     const sizeStats = new Map();
+    const uniqFiles = new Set();
     function addSize({ fileName, size, sourceFileName, exportPath }) {
         if (!sizeStats.has(exportPath)) {
             sizeStats.set(exportPath, []);
         }
         const distFilesStats = sizeStats.get(exportPath);
-        if (distFilesStats) {
-            distFilesStats.push([
-                fileName,
-                sourceFileName,
-                size
-            ]);
+        if (!uniqFiles.has(fileName)) {
+            uniqFiles.add(fileName);
+            if (distFilesStats) {
+                distFilesStats.push([
+                    fileName,
+                    sourceFileName,
+                    size
+                ]);
+            }
         }
     }
     const reversedMapping = new Map();
@@ -1458,9 +1508,6 @@ function normalizeExportName(exportName) {
     }
     return result;
 }
-function getExportNameWithoutExportCondition(exportName) {
-    return exportName.includes('.') ? exportName.split('.')[0] : exportName;
-}
 function logOutputState(sizeCollector) {
     const stats = sizeCollector.getSizeStats();
     if (stats.size === 0) {
@@ -1472,7 +1519,7 @@ function logOutputState(sizeCollector) {
     const statsArray = [
         ...stats.entries()
     ].sort(([a], [b])=>{
-        const comp = getExportNameWithoutExportCondition(a).length - getExportNameWithoutExportCondition(b).length;
+        const comp = normalizeExportPath(a).length - normalizeExportPath(b).length;
         return comp === 0 ? a.localeCompare(b) : comp;
     });
     const maxLengthOfExportName = Math.max(...statsArray.map(([exportName])=>normalizeExportName(exportName).length));
@@ -1616,8 +1663,7 @@ async function bundle(cliEntryPath, { cwd: _cwd, ...options } = {}) {
             entriesAlias
         }
     };
-    const buildConfigs = await buildEntryConfig(options, buildContext, false);
-    const assetsJobs = buildConfigs.map((rollupConfig)=>bundleOrWatch(rollupConfig));
+    const assetsJobs = (await buildEntryConfig(options, buildContext, false)).map((rollupConfig)=>bundleOrWatch(rollupConfig));
     const typesJobs = hasTsConfig && options.dts !== false ? (await buildEntryConfig(options, buildContext, true)).map((rollupConfig)=>bundleOrWatch(rollupConfig)) : [];
     const totalJobs = assetsJobs.concat(typesJobs);
     const result = await Promise.all(totalJobs);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunchee",
-  "version": "5.0.0-beta.1",
+  "version": "5.0.0-beta.3",
   "description": "zero config bundler for js/ts/jsx libraries",
   "bin": "./dist/bin/cli.js",
   "main": "./dist/index.js",
@@ -110,7 +110,7 @@
     "test:update": "TEST_UPDATE_SNAPSHOT=1 pnpm test",
     "test:post": "POST_BUILD=1 pnpm jest test/compile.test.ts test/integration.test.ts",
     "clean": "rm -rf ./dist",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsc --noEmit && tsc -p test/tsconfig.json --noEmit",
     "build": "tsx ./src/bin/index.ts --runtime node",
     "format": "prettier --write ."
   }

package/dist/bin/cli.d.ts

@@ -1 +0,0 @@
-#!/usr/bin/env node