bunchee 6.0.2 → 6.0.4

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

@@ -154,9 +154,8 @@ const logger = {
     }
 };
 
-const { sep } = require('path');
-function relativify(path) {
-    return path.startsWith('.') ? path : `.${sep}${path}`;
+function posixRelativify(path) {
+    return path.startsWith('.') ? path : `./${path}`;
 }
 
 function exit(err) {
@@ -217,7 +216,7 @@ function isTypeFile(filename) {
 function sourceFilenameToExportFullPath(filename) {
     const ext = path__default.default.extname(filename);
     const exportPath = filename.slice(0, -ext.length);
-    return relativify(exportPath);
+    return posixRelativify(exportPath);
 }
 // If the file is matching the private module convention file export path.
 // './lib/_foo' -> true
@@ -227,6 +226,9 @@ function sourceFilenameToExportFullPath(filename) {
 function isPrivateExportPath(exportPath) {
     return /\/_/.test(exportPath);
 }
+function normalizePath(filePath) {
+    return filePath.replace(/\\/g, '/');
+}
 
 function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exportToDist) {
     // End of searching, export value is file path.
@@ -376,10 +378,10 @@ function getExportTypeFromFile(filename, pkgType) {
 const matchFile = (matchingPattern, filePath)=>{
     return matchingPattern.some((pattern)=>{
         // pattern is always posix
-        const normalizedPattern = path__default.default.posix.normalize(pattern);
+        const normalizedPattern = path.posix.normalize(pattern);
         const expandedPattern = normalizedPattern.endsWith('/') ? `${normalizedPattern}**` : `${normalizedPattern}/**`;
         const matcher = picomatch__default.default(expandedPattern);
-        const normalizedFilePath = path__default.default.normalize(filePath.replace(/\\/g, '/'));
+        const normalizedFilePath = path.posix.normalize(filePath);
         return matcher(normalizedFilePath);
     });
 };
@@ -394,12 +396,12 @@ function validateTypesFieldCondition(pair) {
 }
 function validateFilesField(packageJson) {
     const state = {
-        definedField: true,
         missingFiles: []
     };
-    const filesField = packageJson.files || [];
+    const filesField = packageJson.files || [
+        '*'
+    ];
     const exportsField = packageJson.exports || {};
-    state.definedField = !!packageJson.files;
     const resolveExportsPaths = (exports)=>{
         const paths = [];
         if (typeof exports === 'string') {
@@ -411,7 +413,7 @@ function validateFilesField(packageJson) {
         }
         return paths;
     };
-    const exportedPaths = resolveExportsPaths(exportsField).map((p)=>path__default.default.normalize(p));
+    const exportedPaths = resolveExportsPaths(exportsField).map((p)=>normalizePath(path__default.default.normalize(p)));
     const commonFields = [
         'main',
         'module',
@@ -559,12 +561,8 @@ function lint$1(pkg) {
     const warningsCount = exportsState.badTypesExport.length + fieldState.missingFiles.length;
     if (warningsCount) {
         logger.warn(`Lint: ${warningsCount} issues found.`);
-    } else {
-        logger.info(`Lint: package.json is healthy.`);
     }
-    if (!fieldState.definedField) {
-        logger.warn('Missing files field in package.json');
-    } else if (fieldState.missingFiles.length) {
+    if (fieldState.missingFiles.length) {
         logger.warn('Missing files in package.json');
         fieldState.missingFiles.forEach((p)=>{
             logger.warn(`  ${p}`);
@@ -614,7 +612,7 @@ function lint$1(pkg) {
     }
 }
 
-var version = "6.0.2";
+var version = "6.0.4";
 
 async function writeDefaultTsconfig(tsConfigPath) {
     await fs.promises.writeFile(tsConfigPath, JSON.stringify(DEFAULT_TS_CONFIG, null, 2), 'utf-8');
@@ -673,12 +671,12 @@ function normalizeExportPath(exportPath) {
 async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpath, bins, exportsEntries) {
     const isBinaryPath = isBinExportPath(originalSubpath);
     const subpath = originalSubpath.replace(BINARY_TAG, 'bin');
-    const absoluteDirPath = path.join(sourceFolderPath, subpath);
-    const dirName = path.dirname(subpath) // Get directory name regardless of file/directory
+    const absoluteDirPath = path__default.default.join(sourceFolderPath, subpath);
+    const dirName = path__default.default.dirname(subpath) // Get directory name regardless of file/directory
     ;
-    const baseName = path.basename(subpath) // Get base name regardless of file/directory
+    const baseName = path__default.default.basename(subpath) // Get base name regardless of file/directory
     ;
-    const dirPath = path.join(sourceFolderPath, dirName);
+    const dirPath = path__default.default.join(sourceFolderPath, dirName);
     // Match <name>{,/index}.{<ext>,<runtime>.<ext>}
     const globalPatterns = [
         `${baseName}.{${[
@@ -704,14 +702,14 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
         ignore: '**/_*'
     });
     for (const file of files){
-        const ext = path.extname(file).slice(1);
+        const ext = path__default.default.extname(file).slice(1);
         if (!availableExtensions.has(ext) || isTestFile(file)) continue;
-        const sourceFileAbsolutePath = path.join(dirPath, file);
-        const exportPath = relativify(fs.existsSync(absoluteDirPath) && (await fsp__default.default.stat(absoluteDirPath)).isDirectory() ? subpath : originalSubpath);
+        const sourceFileAbsolutePath = path__default.default.join(dirPath, file);
+        const exportPath = posixRelativify(fs.existsSync(absoluteDirPath) && (await fsp__default.default.stat(absoluteDirPath)).isDirectory() ? subpath : originalSubpath);
         if (isBinaryPath) {
             bins.set(normalizeExportPath(originalSubpath), sourceFileAbsolutePath);
         } else {
-            const parts = path.basename(file).split('.');
+            const parts = path__default.default.basename(file).split('.');
             const exportType = parts.length > 2 ? parts[1] : getExportTypeFromExportPath(exportPath);
             const specialExportPath = exportType !== 'index' && parts.length > 2 ? exportPath + '.' + exportType : exportPath // Adjust for direct file matches
             ;
@@ -757,12 +755,12 @@ async function collectSourceEntries(sourceFolderPath) {
     });
     for (const file of binMatches){
         // convert relative path to export path
-        const exportPath = sourceFilenameToExportFullPath(file);
+        const exportPath = sourceFilenameToExportFullPath(normalizePath(file));
         const binExportPath = exportPath.replace(/^\.[\//]bin/, BINARY_TAG);
         await collectSourceEntriesByExportPath(sourceFolderPath, binExportPath, bins, exportsEntries);
     }
     for (const file of srcMatches){
-        const binExportPath = file.replace(/^bin/, BINARY_TAG)// Remove index.<ext> to [^index].<ext> to build the export path
+        const binExportPath = normalizePath(file).replace(/^bin/, BINARY_TAG)// Remove index.<ext> to [^index].<ext> to build the export path
         .replace(/(\/index)?\.[^/]+$/, '');
         await collectSourceEntriesByExportPath(sourceFolderPath, binExportPath, bins, exportsEntries);
     }
@@ -774,7 +772,7 @@ async function collectSourceEntries(sourceFolderPath) {
 
 // Output with posix style in package.json
 function getDistPath(...subPaths) {
-    return relativify(path.posix.join(DIST, ...subPaths));
+    return posixRelativify(path.posix.join(DIST, ...subPaths));
 }
 function stripeBinaryTag(exportName) {
     // Add \ to decode leading $
@@ -782,7 +780,7 @@ function stripeBinaryTag(exportName) {
 }
 const normalizeBaseNameToExportName = (name)=>{
     const baseName = stripeBinaryTag(name);
-    return /^\.\/index(\.|$)/.test(baseName) ? '.' : relativify(baseName);
+    return /^\.\/index(\.|$)/.test(baseName) ? '.' : posixRelativify(baseName);
 };
 function createExportCondition(exportName, sourceFile, moduleType) {
     const isTsSourceFile = isTypescriptFile(sourceFile);

package/dist/index.js

@@ -242,9 +242,8 @@ const DEFAULT_TS_CONFIG = {
 };
 const BINARY_TAG = '$binary';
 
-const { sep } = require('path');
-function relativify(path) {
-    return path.startsWith('.') ? path : `.${sep}${path}`;
+function posixRelativify(path) {
+    return path.startsWith('.') ? path : `./${path}`;
 }
 
 function exit(err) {
@@ -376,7 +375,10 @@ function isBinExportPath(exportPath) {
 function sourceFilenameToExportFullPath(filename) {
     const ext = path__default.default.extname(filename);
     const exportPath = filename.slice(0, -ext.length);
-    return relativify(exportPath);
+    return posixRelativify(exportPath);
+}
+function normalizePath(filePath) {
+    return filePath.replace(/\\/g, '/');
 }
 
 function collectExportPath(exportValue, exportKey, currentPath, exportTypes, exportToDist) {
@@ -571,7 +573,7 @@ function getExportFileTypePath(absoluteJsBundlePath) {
     const baseName = baseNameWithoutExtension(absoluteJsBundlePath);
     const ext = path.extname(absoluteJsBundlePath).slice(1);
     const typeExtension = dtsExtensionsMap[ext];
-    return path.join(dirName, baseName + '.' + typeExtension);
+    return normalizePath(path.join(dirName, baseName + '.' + typeExtension));
 }
 function getExportTypeFromFile(filename, pkgType) {
     const isESModule = isESModulePackage(pkgType);
@@ -594,7 +596,7 @@ async function collectEntriesFromParsedExports(cwd, parsedExportsInfo, pkg, sour
         };
     }
     // Find source files
-    const { bins, exportsEntries } = await collectSourceEntriesFromExportPaths(path.join(cwd, SRC), parsedExportsInfo, pkg);
+    const { bins, exportsEntries } = await collectSourceEntriesFromExportPaths(path__default.default.join(cwd, SRC), parsedExportsInfo, pkg);
     // A mapping between each export path and its related special export conditions,
     // excluding the 'default' export condition.
     // { './index' => Set('development', 'edge-light') }
@@ -743,12 +745,12 @@ function stripSpecialCondition(exportPath) {
 async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpath, bins, exportsEntries) {
     const isBinaryPath = isBinExportPath(originalSubpath);
     const subpath = originalSubpath.replace(BINARY_TAG, 'bin');
-    const absoluteDirPath = path.join(sourceFolderPath, subpath);
-    const dirName = path.dirname(subpath) // Get directory name regardless of file/directory
+    const absoluteDirPath = path__default.default.join(sourceFolderPath, subpath);
+    const dirName = path__default.default.dirname(subpath) // Get directory name regardless of file/directory
     ;
-    const baseName = path.basename(subpath) // Get base name regardless of file/directory
+    const baseName = path__default.default.basename(subpath) // Get base name regardless of file/directory
     ;
-    const dirPath = path.join(sourceFolderPath, dirName);
+    const dirPath = path__default.default.join(sourceFolderPath, dirName);
     // Match <name>{,/index}.{<ext>,<runtime>.<ext>}
     const globalPatterns = [
         `${baseName}.{${[
@@ -774,14 +776,14 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
         ignore: '**/_*'
     });
     for (const file of files){
-        const ext = path.extname(file).slice(1);
+        const ext = path__default.default.extname(file).slice(1);
         if (!availableExtensions.has(ext) || isTestFile(file)) continue;
-        const sourceFileAbsolutePath = path.join(dirPath, file);
-        const exportPath = relativify(fs.existsSync(absoluteDirPath) && (await fsp__default.default.stat(absoluteDirPath)).isDirectory() ? subpath : originalSubpath);
+        const sourceFileAbsolutePath = path__default.default.join(dirPath, file);
+        const exportPath = posixRelativify(fs.existsSync(absoluteDirPath) && (await fsp__default.default.stat(absoluteDirPath)).isDirectory() ? subpath : originalSubpath);
         if (isBinaryPath) {
             bins.set(normalizeExportPath(originalSubpath), sourceFileAbsolutePath);
         } else {
-            const parts = path.basename(file).split('.');
+            const parts = path__default.default.basename(file).split('.');
             const exportType = parts.length > 2 ? parts[1] : getExportTypeFromExportPath(exportPath);
             const specialExportPath = exportType !== 'index' && parts.length > 2 ? exportPath + '.' + exportType : exportPath // Adjust for direct file matches
             ;
@@ -841,7 +843,7 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
         nodir: true
     });
     for (const file of privateFiles){
-        const sourceFileAbsolutePath = path.join(sourceFolderPath, file);
+        const sourceFileAbsolutePath = path__default.default.join(sourceFolderPath, file);
         const exportPath = sourceFilenameToExportFullPath(file);
         const isEsmPkg = isESModulePackage(pkg.type);
         // const specialItems: [string, string][] = []
@@ -855,11 +857,11 @@ async function collectSourceEntriesByExportPath(sourceFolderPath, originalSubpat
         // e.g. ./_utils.ts -> ./dist/_utils.js
         const privateExportInfo = [
             [
-                relativify(path.join('./dist', exportPath + (isEsmPkg ? '.js' : '.mjs'))),
+                posixRelativify(path.posix.join('./dist', exportPath + (isEsmPkg ? '.js' : '.mjs'))),
                 condPart + 'import'
             ],
             [
-                relativify(path.join('./dist', exportPath + (isEsmPkg ? '.cjs' : '.js'))),
+                posixRelativify(path.posix.join('./dist', exportPath + (isEsmPkg ? '.cjs' : '.js'))),
                 condPart + 'require'
             ]
         ];
@@ -930,9 +932,9 @@ function createOutputState({ entries }) {
                         const sourceFileName = chunk.facadeModuleId || '';
                         const exportPath = removeScope(reversedMapping.get(sourceFileName) || '.');
                         addSize({
-                            fileName: path__default.default.relative(cwd, filePath).replace(path__default.default.sep, '/'),
+                            fileName: normalizePath(path__default.default.relative(cwd, filePath)),
                             size,
-                            sourceFileName,
+                            sourceFileName: normalizePath(sourceFileName),
                             exportPath
                         });
                     });
@@ -1320,7 +1322,7 @@ function aliasEntries({ entry: sourceFilePath, conditionNames, entries, format,
                         const absoluteBundlePath = path.posix.resolve(cwd, srcBundle);
                         const absoluteImportBundlePath = path.posix.resolve(cwd, resolvedModuleBundle);
                         const filePathBase = path.posix.relative(path.posix.dirname(absoluteBundlePath), absoluteImportBundlePath);
-                        const relativePath = relativify(filePathBase);
+                        const relativePath = posixRelativify(normalizePath(filePathBase));
                         return {
                             id: relativePath,
                             external: true
@@ -1524,9 +1526,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.2",
+  "version": "6.0.4",
   "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": {
@@ -111,11 +114,15 @@
   },
   "scripts": {
     "test": "jest --env node",
+    "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",
-    "test:ci": "[ -z $CI ] || pnpm test",
+    "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",
+    "publish-local": "pnpm prepare-release && pnpm test && pnpm publish",
     "run-ts": "cross-env SWC_NODE_IGNORE_DYNAMIC=1 node -r @swc-node/register",
     "ts-bunchee": "pnpm run-ts ./src/bin/index.ts",
     "build-dir": "pnpm ts-bunchee --cwd",