bunchee 4.3.3 → 4.4.0

package/README.md

@@ -34,6 +34,7 @@ npm install --save-dev bunchee typescript
 ### Configuration
 
 Create your library entry file and package.json.
+
 ```sh
 cd ./my-lib
 mkdir src && touch ./src/index.ts
@@ -57,18 +58,20 @@ Or you can checkout the following cases to configure your package.json.
   <summary> JavaScript</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"],
   "exports": {
     "import": "./dist/es/index.mjs",
-    "require": "./dist/cjs/index.cjs"
+    "require": "./dist/cjs/index.js"
   },
   "scripts": {
     "build": "bunchee"
   }
 }
 ```
+
 </details>
 
 <details>
@@ -85,8 +88,8 @@ If you're build a TypeScript library, separate the types from the main entry fil
       "default": "./dist/es/index.mjs"
     },
     "require": {
-      "types": "./dist/cjs/index.d.cts",
-      "default": "./dist/cjs/index.cjs"
+      "types": "./dist/cjs/index.d.ts",
+      "default": "./dist/cjs/index.js"
     }
   },
   "scripts": {
@@ -94,8 +97,8 @@ If you're build a TypeScript library, separate the types from the main entry fil
   }
 }
 ```
-</details>
 
+</details>
 
 <details>
   <summary>Hybrid (CJS & ESM) Module Resolution with TypeScript</summary>
@@ -104,13 +107,13 @@ If you're using TypeScript with Node 10 and Node 16 module resolution, you can u
 ```json
 {
   "files": ["dist"],
-  "main": "./dist/cjs/index.cjs",
+  "main": "./dist/cjs/index.js",
   "module": "./dist/es/index.mjs",
   "types": "./dist/cjs/index.d.ts",
   "exports": {
     "import": {
-      "types": "./dist/es/index.d.mts",
-      "default": "./dist/es/index.mjs"
+      "types": "./dist/es/index.d.ts",
+      "default": "./dist/es/index.js"
     },
     "require": {
       "types": "./dist/cjs/index.d.cts",
@@ -122,6 +125,7 @@ If you're using TypeScript with Node 10 and Node 16 module resolution, you can u
   }
 }
 ```
+
 </details>
 
 #### Build
@@ -240,7 +244,6 @@ This will match the `bin` field in package.json as:
 
 > Note: For multiple `bin` files, the filename should match the key name in the `bin` field.
 
-
 ### Server Components
 
 `bunchee` supports to build server components and server actions with library directives like `"use client"` or `"use server"`. It will generate the corresponding chunks for client and server that scope the client and server boundaries properly.
@@ -265,6 +268,7 @@ If you're using `"use client"` or `"use server"` in a file that used as a depend
 - Types (`--dts`): Generate TypeScript declaration files along with assets.
 - 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`)
 
 ```sh
 cd <project-root-dir>
@@ -280,7 +284,7 @@ bunchee ./src/index.js --runtime node --target es2019
 
 #### Specifying extra external dependencies
 
-By default, `bunchee` will mark all the `dependencies` and `peerDependencies` as externals so you don't need to pass them as CLI args. 
+By default, `bunchee` will mark all the `dependencies` and `peerDependencies` as externals so you don't need to pass them as CLI args.
 But if there's any dependency that used but not in the dependency list and you want to mark as external, you can use the `--external` option to specify them.
 
 ```sh
@@ -309,7 +313,6 @@ bunchee --env=ENV1,ENV2,ENV3
 
 Replace `ENV1`, `ENV2`, and `ENV3` with the names of the environment variables you want to include in your bundled code. These environment variables will be inlined during the bundling process.
 
-
 You can use `index.<export-type>.<ext>` to override the input source file for specific export name. Or using `<export-path>/index.<export-type>.<ext>` also works. Such as:
 
 ```
@@ -321,6 +324,20 @@ You can use `index.<export-type>.<ext>` to override the input source file for sp
 
 This will match the export name `"react-server"` and `"edge-light"` then use the corresponding input source file to build the bundle.
 
+#### Auto Development and Production Mode
+
+`process.env.NODE_ENV` is injected by default if present that you don't need to manually inject yourself. If you need to separate the development build and production build, `bunchee` provides different export conditions for development and production mode with `development` and `production` export conditions.
+
+```json
+{
+  "exports": {
+    "development": "./dist/index.development.js",
+    "production": "./dist/index.production.js"
+  }
+}
+```
+
+Then you can use `bunchee` to build the development bundle and production bundle automatically.
 
 ### Wildcard Exports
 
@@ -402,6 +419,7 @@ If you just want to import a file as string content, you can name the extension
 For example:
 
 src/index.ts
+
 ```js
 import data from './data.txt'
 
@@ -409,11 +427,13 @@ export default data
 ```
 
 src/data.txt
+
 ```txt
 hello world
 ```
 
 output
+
 ```
 export default "hello world"
 ```
@@ -435,6 +455,7 @@ await bundle(path.resolve('./src/index.ts'), {
   target: 'es2015', // ES syntax target
   runtime: 'nodejs', // 'browser' | 'nodejs'
   cwd: process.cwd(), // string
+  clean: true, // boolean
 })
 ```
 
@@ -450,7 +471,6 @@ If you specify `target` option in `tsconfig.json`, then you don't have to pass i
 
 `bunchee` has support for checking the package bundles are matched with package exports configuration.
 
-
 ### License
 
 MIT