bunchee 6.0.3 → 6.1.0

package/README.md

@@ -22,28 +22,45 @@ It uses the standard exports configuration in `package.json` as the only source
 ### Installation
 
 ```sh
-npm install --save-dev bunchee
+npm install --save-dev bunchee typescript
 ```
 
-If you're using TypeScript
+### Configuration
+
+Create entry files of your library and `package.json`.
 
 ```sh
-npm install --save-dev bunchee typescript
+cd ./coffee
+mkdir src && touch ./src/index.ts && touch package.json
 ```
 
-### Configuration
+Add the exports in `package.json`.
 
-Create your library entry file and package.json.
+```json
+{
+  "name": "coffee",
+  "type": "module",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "bunchee"
+  }
+}
+```
+
+#### Build
 
 ```sh
-cd ./my-lib
-mkdir src && touch ./src/index.ts
+npm run build
 ```
 
-#### Build
+Then files in `src` folders will be treated as entry files and match the export names in package.json.
+Simply like Node.js module resolution, each export name will match the file in `src/` directory.
+
+For example:
 
-Then files in `src` folders will be treated as entry files and match the export names in package.json. For example:
-`src/index.ts` will match the exports name `"."` or the only main export.
+- `src/index.ts` will match the exports name `"."` or the only main export.
+- `src/lite.ts` will match the exports name `"./lite"`.
+- `src/react/index.ts` will match the exports name `"./react"`.
 
 Now just run `npm run build` (or `pnpm build` / `yarn build`) if you're using these package managers, `bunchee` will find the entry files and build them.
 The output format will based on the exports condition and also the file extension. Given an example:
@@ -69,16 +86,17 @@ npm exec bunchee prepare
 Or you can checkout the following cases to configure your package.json.
 
 <details>
-  <summary> JavaScript</summary>
+  <summary>JavaScript ESModule</summary>
 
 Then use use the [exports field in package.json](https://nodejs.org/api/packages.html#exports-sugar) to configure different conditions and leverage the same functionality as other bundlers, such as webpack. The exports field allows you to define multiple conditions.
 
 ```json
 {
   "files": ["dist"],
+  "type": "module",
   "exports": {
-    "import": "./dist/es/index.mjs",
-    "require": "./dist/cjs/index.js"
+    ".": "./dist/es/index.js",
+    "./react": "./dist/es/react.js"
   },
   "scripts": {
     "build": "bunchee"
@@ -91,19 +109,21 @@ Then use use the [exports field in package.json](https://nodejs.org/api/packages
 <details>
   <summary>TypeScript</summary>
 
-If you're build a TypeScript library, separate the types from the main entry file and specify the types path in package.json. When you're using `.mjs` or `.cjs` extensions with TypeScript and modern module resolution (above node16), TypeScript will require specific type declaration files like `.d.mts` or `.d.cts` to match the extension. `bunchee` can automatically generate them to match the types to match the condition and extensions. One example is to configure your exports like this in package.json:
+If you're build a TypeScript library, separate the types from the main entry file and specify the types path in package.json. Types exports need to stay on the top of each export with `types` condition, and you can use `default` condition for the JS bundle file.
 
 ```json
 {
   "files": ["dist"],
+  "type": "module",
+  "main": "./dist/index.js",
   "exports": {
-    "import": {
-      "types": "./dist/es/index.d.mts",
-      "default": "./dist/es/index.mjs"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
-    "require": {
-      "types": "./dist/cjs/index.d.ts",
-      "default": "./dist/cjs/index.js"
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "default": "./dist/react/index.js"
     }
   },
   "scripts": {
@@ -118,20 +138,23 @@ If you're build a TypeScript library, separate the types from the main entry fil
   <summary>Hybrid (CJS & ESM) Module Resolution with TypeScript</summary>
 If you're using TypeScript with Node 10 and Node 16 module resolution, you can use the `types` field in package.json to specify the types path. Then `bunchee` will generate the types file with the same extension as the main entry file.
 
+_NOTE_: When you're using `.mjs` or `.cjs` extensions with TypeScript and modern module resolution (above node16), TypeScript will require specific type declaration files like `.d.mts` or `.d.cts` to match the extension. `bunchee` can automatically generate them to match the types to match the condition and extensions.
+
 ```json
 {
   "files": ["dist"],
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/es/index.mjs",
-  "types": "./dist/cjs/index.d.ts",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     "import": {
-      "types": "./dist/es/index.d.ts",
-      "default": "./dist/es/index.js"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "require": {
-      "types": "./dist/cjs/index.d.cts",
-      "default": "./dist/cjs/index.cjs"
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
     }
   },
   "scripts": {
@@ -176,10 +199,11 @@ Assuming you have default export package as `"."` and subpath export `"./lite"`
   "scripts": {
     "build": "bunchee"
   },
+  "type": "module",
   "exports": {
     "./lite": "./dist/lite.js",
     ".": {
-      "import": "./dist/index.mjs",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     }
   }

package/dist/bin/cli.js

@@ -74,6 +74,7 @@ const DEFAULT_TS_CONFIG = {
     }
 };
 const BINARY_TAG = '$binary';
+const PRIVATE_GLOB_PATTERN = '**/_*/**';
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -158,6 +159,36 @@ function posixRelativify(path) {
     return path.startsWith('.') ? path : `./${path}`;
 }
 
+// Example: ./src/util/foo.development.ts -> foo.development
+// Example: ./src/util/foo.react-server.ts -> foo.react-server
+const baseNameWithoutExtension = (filePath)=>{
+    return path__default.default.basename(filePath, path__default.default.extname(filePath));
+};
+function validateEntryFiles(entryFiles) {
+    const fileBasePaths = new Set();
+    const duplicatePaths = new Set();
+    for (const filePath of entryFiles){
+        // Check if there are multiple files with the same base name
+        const filePathWithoutExt = filePath.slice(0, -path__default.default.extname(filePath).length).replace(/\\/g, '/');
+        const segments = filePathWithoutExt.split('/');
+        const lastSegment = segments.pop() || '';
+        if (lastSegment !== 'index' && lastSegment !== '') {
+            segments.push(lastSegment);
+        }
+        const fileBasePath = segments.join('/');
+        if (fileBasePaths.has(fileBasePath)) {
+            duplicatePaths.add(// Add a dot if the base name is empty, 'foo' -> './foo', '' -> '.'
+            './' + filePath.replace(/\\/g, '/'));
+        }
+        fileBasePaths.add(fileBasePath);
+    }
+    if (duplicatePaths.size > 0) {
+        throw new Error(`Conflicted entry files found for entries: ${[
+            ...duplicatePaths
+        ].join(', ')}`);
+    }
+}
+
 function exit(err) {
     logger.error(err);
     process.exit(1);
@@ -188,8 +219,6 @@ const getMainFieldExportType = (pkg)=>{
     const mainExportType = isEsmPkg && pkg.main ? hasCjsExtension(pkg.main) ? 'require' : 'import' : 'require';
     return mainExportType;
 };
-// TODO: add unit test
-const baseNameWithoutExtension = (filename)=>path__default.default.basename(filename, path__default.default.extname(filename));
 const isTestFile = (filename)=>/\.(test|spec)$/.test(baseNameWithoutExtension(filename));
 function joinRelativePath(...segments) {
     let result = path__default.default.join(...segments);
@@ -612,7 +641,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "6.0.3";
+var version = "6.1.0";
 
 async function writeDefaultTsconfig(tsConfigPath) {
     await fs.promises.writeFile(tsConfigPath, JSON.stringify(DEFAULT_TS_CONFIG, null, 2), 'utf-8');
@@ -678,7 +707,7 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
     ;
     const dirPath = path__default.default.join(sourceFolderPath, dirName);
     // Match <name>{,/index}.{<ext>,<runtime>.<ext>}
-    const globalPatterns = [
+    const entryFilesPatterns = [
         `${baseName}.{${[
             ...availableExtensions
         ].join(',')}}`,
@@ -696,12 +725,13 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
             ...availableExtensions
         ].join(',')}}`
     ];
-    const files = await glob.glob(globalPatterns, {
+    const entryFiles = await glob.glob(entryFilesPatterns, {
         cwd: dirPath,
         nodir: true,
-        ignore: '**/_*'
+        ignore: PRIVATE_GLOB_PATTERN
     });
-    for (const file of files){
+    validateEntryFiles(entryFiles);
+    for (const file of entryFiles){
         const ext = path__default.default.extname(file).slice(1);
         if (!availableExtensions.has(ext) || isTestFile(file)) continue;
         const sourceFileAbsolutePath = path__default.default.join(dirPath, file);
@@ -746,12 +776,12 @@ async function collectSourceEntries(sourceFolderPath) {
     const binMatches = await glob.glob(binPattern, {
         cwd: sourceFolderPath,
         nodir: true,
-        ignore: '**/_*'
+        ignore: PRIVATE_GLOB_PATTERN
     });
     const srcMatches = await glob.glob(srcPattern, {
         cwd: sourceFolderPath,
         nodir: true,
-        ignore: '**/_*'
+        ignore: PRIVATE_GLOB_PATTERN
     });
     for (const file of binMatches){
         // convert relative path to export path

package/dist/index.js

@@ -241,11 +241,42 @@ const DEFAULT_TS_CONFIG = {
     }
 };
 const BINARY_TAG = '$binary';
+const PRIVATE_GLOB_PATTERN = '**/_*/**';
 
 function posixRelativify(path) {
     return path.startsWith('.') ? path : `./${path}`;
 }
 
+// Example: ./src/util/foo.development.ts -> foo.development
+// Example: ./src/util/foo.react-server.ts -> foo.react-server
+const baseNameWithoutExtension = (filePath)=>{
+    return path__default.default.basename(filePath, path__default.default.extname(filePath));
+};
+function validateEntryFiles(entryFiles) {
+    const fileBasePaths = new Set();
+    const duplicatePaths = new Set();
+    for (const filePath of entryFiles){
+        // Check if there are multiple files with the same base name
+        const filePathWithoutExt = filePath.slice(0, -path__default.default.extname(filePath).length).replace(/\\/g, '/');
+        const segments = filePathWithoutExt.split('/');
+        const lastSegment = segments.pop() || '';
+        if (lastSegment !== 'index' && lastSegment !== '') {
+            segments.push(lastSegment);
+        }
+        const fileBasePath = segments.join('/');
+        if (fileBasePaths.has(fileBasePath)) {
+            duplicatePaths.add(// Add a dot if the base name is empty, 'foo' -> './foo', '' -> '.'
+            './' + filePath.replace(/\\/g, '/'));
+        }
+        fileBasePaths.add(fileBasePath);
+    }
+    if (duplicatePaths.size > 0) {
+        throw new Error(`Conflicted entry files found for entries: ${[
+            ...duplicatePaths
+        ].join(', ')}`);
+    }
+}
+
 function exit(err) {
     logger.error(err);
     process.exit(1);
@@ -325,8 +356,6 @@ const getMainFieldExportType = (pkg)=>{
     const mainExportType = isEsmPkg && pkg.main ? hasCjsExtension(pkg.main) ? 'require' : 'import' : 'require';
     return mainExportType;
 };
-// TODO: add unit test
-const baseNameWithoutExtension = (filename)=>path__default.default.basename(filename, path__default.default.extname(filename));
 const isTestFile = (filename)=>/\.(test|spec)$/.test(baseNameWithoutExtension(filename));
 function joinRelativePath(...segments) {
     let result = path__default.default.join(...segments);
@@ -752,7 +781,7 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
     ;
     const dirPath = path__default.default.join(sourceFolderPath, dirName);
     // Match <name>{,/index}.{<ext>,<runtime>.<ext>}
-    const globalPatterns = [
+    const entryFilesPatterns = [
         `${baseName}.{${[
             ...availableExtensions
         ].join(',')}}`,
@@ -770,12 +799,13 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
             ...availableExtensions
         ].join(',')}}`
     ];
-    const files = await glob.glob(globalPatterns, {
+    const entryFiles = await glob.glob(entryFilesPatterns, {
         cwd: dirPath,
         nodir: true,
-        ignore: '**/_*'
+        ignore: PRIVATE_GLOB_PATTERN
     });
-    for (const file of files){
+    validateEntryFiles(entryFiles);
+    for (const file of entryFiles){
         const ext = path__default.default.extname(file).slice(1);
         if (!availableExtensions.has(ext) || isTestFile(file)) continue;
         const sourceFileAbsolutePath = path__default.default.join(dirPath, file);
@@ -826,18 +856,16 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
         }
     }
     // Search private shared module files which are not in the parsedExportsInfo, but start with _.
-    // e.g. _utils.ts, _utils/index.ts
-    // e.g. _utils.development.ts, _utils/index.development.js
-    const privatePattern = [
-        `**/_*{,/index}.{${[
-            ...availableExtensions
-        ].join(',')}}`,
-        `**/_*{,/index}.{${[
-            ...runtimeExportConventions
-        ].join(',')}}.{${[
-            ...availableExtensions
-        ].join(',')}}`
-    ];
+    // Leading underscore: e.g. _utils.ts, _utils/index.ts
+    // Segment contains leading underscore: e.g. a/_b/_c.ts, a/b/_c/index.ts
+    // Contains special suffix: e.g. _utils.development.ts, _utils/index.development.js
+    const suffixPattern = [
+        ...runtimeExportConventions
+    ].join(',');
+    const extPattern = [
+        ...availableExtensions
+    ].join(',');
+    const privatePattern = `**/_*{,/*}{,{.${suffixPattern}}}.{${extPattern}}`;
     const privateFiles = await glob.glob(privatePattern, {
         cwd: sourceFolderPath,
         nodir: true
@@ -855,6 +883,7 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
         const condPart = isSpecialExport ? specialExportType + '.' : '';
         // Map private shared files to the dist directory
         // e.g. ./_utils.ts -> ./dist/_utils.js
+        // TODO: improve the logic to only generate the required files, not all possible files
         const privateExportInfo = [
             [
                 posixRelativify(path.posix.join('./dist', exportPath + (isEsmPkg ? '.js' : '.mjs'))),
@@ -1526,9 +1555,7 @@ async function buildInputConfig(entry, bundleConfig, exportCondition, buildConte
             return externals.some((name)=>id === name || id.startsWith(name + '/'));
         },
         plugins,
-        treeshake: {
-            propertyReadSideEffects: false
-        },
+        treeshake: 'recommended',
         onwarn (warning, warn) {
             const code = warning.code || '';
             // Some may not have types, like CLI binary

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunchee",
-  "version": "6.0.3",
+  "version": "6.1.0",
   "description": "zero config bundler for js/ts/jsx libraries",
   "bin": "./dist/bin/cli.js",
   "main": "./dist/index.js",
@@ -77,15 +77,18 @@
     "@types/jest": "29.0.0",
     "@types/node": "^22.9.3",
     "@types/picomatch": "^3.0.1",
+    "@types/react": "19.0.1",
     "@types/yargs": "^17.0.33",
     "bunchee": "link:./",
     "cross-env": "^7.0.3",
     "husky": "^9.0.11",
     "jest": "29.0.1",
     "lint-staged": "^15.2.2",
+    "next": "^15.0.4",
     "picocolors": "^1.0.0",
     "prettier": "^3.0.0",
-    "react": "^18.3.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
     "typescript": "^5.6.2"
   },
   "lint-staged": {
@@ -114,6 +117,8 @@
     "test:ci": "pnpm test -- --ci",
     "test:update": "TEST_UPDATE_SNAPSHOT=1 pnpm test",
     "test:post": "cross-env POST_BUILD=1 pnpm jest test/compile.test.ts test/integration.test.ts",
+    "docs:dev": "next dev docs",
+    "docs:build": "next build docs",
     "clean": "rm -rf ./dist",
     "typecheck": "tsc --noEmit && tsc -p test/tsconfig.json --noEmit",
     "prepare-release": "pnpm clean && pnpm build",