bunchee 5.0.0-beta.2 → 5.0.0-beta.4

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
@@ -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
@@ -269,6 +326,7 @@ If you're using `"use client"` or `"use server"` in a file that used as a depend
 - Minify (`-m`): Compress output.
 - Watch (`-w`): Watch for source file changes.
 - No Clean(`--no-clean`): Do not clean the dist folder before building. (default: `false`)
+- TSConfig (`--tsconfig <path>`): Specify the path to the TypeScript configuration file. (default: `tsconfig.json`)
 
 ```sh
 cd <project-root-dir>
@@ -401,6 +459,7 @@ await bundle(path.resolve('./src/index.ts'), {
   runtime: 'nodejs', // 'browser' | 'nodejs'
   cwd: process.cwd(), // string
   clean: true, // boolean
+  tsconfig: 'tsconfig.json', // string
 })
 ```
 

package/dist/bin/cli.js

@@ -350,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)=>{
@@ -389,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)=>{
@@ -458,7 +456,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "5.0.0-beta.2";
+var version = "5.0.0-beta.4";
 
 function relativify(path) {
     return path.startsWith('.') ? path : `./${path}`;
@@ -801,6 +799,7 @@ Options:
   --sourcemap            enable sourcemap generation, default: false
   --dts                  determine if need to generate types, default: undefined
   --no-dts               do not generate types, default: undefined
+  --tsconfig             path to tsconfig file, default: tsconfig.json
 `;
 function help() {
     logger.log(helpMessage);
@@ -832,6 +831,7 @@ function parseCliArgs(argv) {
         '--no-external': Boolean,
         '--no-clean': Boolean,
         '--prepare': Boolean,
+        '--tsconfig': String,
         '-h': '--help',
         '-v': '--version',
         '-w': '--watch',
@@ -859,13 +859,14 @@ function parseCliArgs(argv) {
         external: !!args['--no-external'] ? null : args['--external'],
         clean: !args['--no-clean'],
         env: args['--env'],
-        prepare: !!args['--prepare']
+        prepare: !!args['--prepare'],
+        tsconfig: args['--tsconfig']
     };
     return parsedArgs;
 }
 async function run(args) {
     var _args_external;
-    const { source, format, watch, minify, sourcemap, target, runtime, dts, env, clean } = args;
+    const { source, format, watch, minify, sourcemap, target, runtime, dts, env, clean, tsconfig } = args;
     const cwd = args.cwd || process.cwd();
     const file = args.file ? path__default.default.resolve(cwd, args.file) : undefined;
     const bundleConfig = {
@@ -880,7 +881,8 @@ async function run(args) {
         minify: !!minify,
         sourcemap: sourcemap === false ? false : true,
         env: (env == null ? void 0 : env.split(',')) || [],
-        clean
+        clean,
+        tsconfig
     };
     if (args.version) {
         return logger.log(version);

package/dist/index.d.ts

@@ -18,6 +18,7 @@ type BundleConfig = {
     runtime?: string;
     pkg?: PackageMetadata;
     clean?: boolean;
+    tsconfig?: string;
 };
 type PackageMetadata = {
     name?: string;

package/dist/index.js

@@ -305,10 +305,10 @@ function resolveTypescriptHandler(cwd) {
     return ts;
 }
 const resolveTypescript = memoize(resolveTypescriptHandler);
-function resolveTsConfigHandler(cwd) {
+function resolveTsConfigHandler(cwd, tsconfig = 'tsconfig.json') {
     let tsCompilerOptions = {};
     let tsConfigPath;
-    tsConfigPath = path.resolve(cwd, 'tsconfig.json');
+    tsConfigPath = path.resolve(cwd, tsconfig);
     if (fileExists(tsConfigPath)) {
         const ts = resolveTypescript(cwd);
         const basePath = tsConfigPath ? path.dirname(tsConfigPath) : cwd;
@@ -1223,10 +1223,11 @@ 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 layer;
+            return baseName + '-' + layer;
         }
     }
     return undefined;
@@ -1243,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();
@@ -1263,15 +1273,6 @@ function createSplitChunks(dependencyGraphMap, entryFiles) {
                 }
             }
         }
-        if (!isEntry) {
-            const cachedCustomModuleLayer = splitChunksGroupMap.get(id);
-            if (cachedCustomModuleLayer) return cachedCustomModuleLayer;
-            const customModuleLayer = getCustomModuleLayer(id);
-            if (customModuleLayer) {
-                splitChunksGroupMap.set(id, customModuleLayer);
-                return customModuleLayer;
-            }
-        }
         // If current module has a layer, and it's not an entry
         if (moduleLayer && !isEntry) {
             // If the module is imported by the entry:
@@ -1572,7 +1573,7 @@ async function bundle(cliEntryPath, { cwd: _cwd, ...options } = {}) {
     // Original input file path, client path might change later
     const inputFile = cliEntryPath;
     const isFromCli = Boolean(cliEntryPath);
-    let tsConfig = resolveTsConfig(cwd);
+    let tsConfig = resolveTsConfig(cwd, options.tsconfig);
     let hasTsConfig = Boolean(tsConfig == null ? void 0 : tsConfig.tsConfigPath);
     const defaultTsOptions = {
         tsConfigPath: tsConfig == null ? void 0 : tsConfig.tsConfigPath,
@@ -1662,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,10 +1,21 @@
 {
   "name": "bunchee",
-  "version": "5.0.0-beta.2",
+  "version": "5.0.0-beta.4",
   "description": "zero config bundler for js/ts/jsx libraries",
   "bin": "./dist/bin/cli.js",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "scripts": {
+    "test": "jest --env node",
+    "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 && tsc -p test/tsconfig.json --noEmit",
+    "prepublishOnly": "pnpm clean && pnpm build && chmod +x ./dist/bin/cli.js && pnpm test",
+    "build": "tsx ./src/bin/index.ts --runtime node",
+    "format": "prettier --write .",
+    "prepare": "husky install"
+  },
   "type": "commonjs",
   "keywords": [
     "bundler",
@@ -104,14 +115,5 @@
     ],
     "testTimeout": 60000
   },
-  "packageManager": "pnpm@8.8.0",
-  "scripts": {
-    "test": "jest --env node",
-    "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 && tsc -p test/tsconfig.json --noEmit",
-    "build": "tsx ./src/bin/index.ts --runtime node",
-    "format": "prettier --write ."
-  }
-}
+  "packageManager": "pnpm@8.8.0"
+}