bunchee 6.0.4 → 6.1.1

package/README.md

@@ -290,7 +290,7 @@ If you're using `"use client"` or `"use server"` in a file that used as a depend
 
 ### Shared Modules
 
-In some cases, you may need to share code across multiple bundles without promoting them to separate entries or exports. These modules should be bundled into shared chunks that can be reused by various bundles. By convention, files or directories prefixed with an underscore (`_<name>.<ext>` or `_<name>/index.<ext>`) are treated as **shared modules**. They're private and not exposed publicly as entry points or exports.
+In some cases, you may need to share code across multiple bundles without promoting them to separate entries or exports. These modules should be bundled into shared chunks that can be reused by various bundles. By convention, files or directories **prefixed with an underscore** (`_<name>.<ext>` or `_<name>/**`) are treated as **shared modules**. They're private and not exposed publicly as entry points or exports. Testing, mocking related files are ignored. e.g. `_foo/a.test.ts` will not be treated as shared module.
 
 <details>
   <summary>Shared Utils Example</summary>

package/dist/bin/cli.js

@@ -74,6 +74,8 @@ const DEFAULT_TS_CONFIG = {
     }
 };
 const BINARY_TAG = '$binary';
+const PRIVATE_GLOB_PATTERN = '**/_*/**';
+const TESTS_GLOB_PATTERN = '**/{__tests__/**,__mocks__/**,*.{test,spec}.*}';
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -158,6 +160,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 +220,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 +642,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "6.0.4";
+var version = "6.1.1";
 
 async function writeDefaultTsconfig(tsConfigPath) {
     await fs.promises.writeFile(tsConfigPath, JSON.stringify(DEFAULT_TS_CONFIG, null, 2), 'utf-8');
@@ -678,7 +708,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 +726,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 +777,18 @@ async function collectSourceEntries(sourceFolderPath) {
     const binMatches = await glob.glob(binPattern, {
         cwd: sourceFolderPath,
         nodir: true,
-        ignore: '**/_*'
+        ignore: [
+            PRIVATE_GLOB_PATTERN,
+            TESTS_GLOB_PATTERN
+        ]
     });
     const srcMatches = await glob.glob(srcPattern, {
         cwd: sourceFolderPath,
         nodir: true,
-        ignore: '**/_*'
+        ignore: [
+            PRIVATE_GLOB_PATTERN,
+            TESTS_GLOB_PATTERN
+        ]
     });
     for (const file of binMatches){
         // convert relative path to export path

package/dist/index.js

@@ -241,11 +241,43 @@ const DEFAULT_TS_CONFIG = {
     }
 };
 const BINARY_TAG = '$binary';
+const PRIVATE_GLOB_PATTERN = '**/_*/**';
+const TESTS_GLOB_PATTERN = '**/{__tests__/**,__mocks__/**,*.{test,spec}.*}';
 
 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 +357,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 +782,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 +800,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,21 +857,20 @@ 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
+        nodir: true,
+        ignore: TESTS_GLOB_PATTERN
     });
     for (const file of privateFiles){
         const sourceFileAbsolutePath = path__default.default.join(sourceFolderPath, file);
@@ -855,6 +885,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'))),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bunchee",
-  "version": "6.0.4",
+  "version": "6.1.1",
   "description": "zero config bundler for js/ts/jsx libraries",
   "bin": "./dist/bin/cli.js",
   "main": "./dist/index.js",