bunchee - npm Package Compare versions

Comparing version 5.0.0-beta.2 to 5.0.0-beta.3

dist/bin/cli.js

@@ -353,4 +353,3 @@ #!/usr/bin/env node
                 }
-            }
-            if (typeof exports !== 'object') {
+            } else if (typeof exports !== 'object') {
                 state.invalidExportsFieldType = true;
@@ -393,4 +392,3 @@ } else {
                 }
-            }
-            if (typeof exports !== 'object') {
+            } else if (typeof exports !== 'object') {
                 state.invalidExportsFieldType = true;
@@ -463,3 +461,3 @@ } else {
 
-var version = "5.0.0-beta.2";
+var version = "5.0.0-beta.3";
 
@@ -466,0 +464,0 @@ function relativify(path) {

package.json

 {
   "name": "bunchee",
-  "version": "5.0.0-beta.2",
+  "version": "5.0.0-beta.3",
   "description": "zero config bundler for js/ts/jsx libraries",
@@ -5,0 +5,0 @@ "bin": "./dist/bin/cli.js",

README.md

@@ -17,3 +17,3 @@ # bunchee
 
-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.
@@ -256,2 +256,59 @@
 
+### 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
@@ -258,0 +315,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

194430

increased by0.92%

Number of lines in readme file

479

increased by13.51%

Worsened metrics

Lines of code

4407

decreased by-0.05%

No dependency changes