@rsbuild/plugin-node-polyfill 1.0.1 → 1.0.4

package/README.md

@@ -1,6 +1,6 @@
 # @rsbuild/plugin-node-polyfill
 
-@rsbuild/plugin-node-polyfill is a Rsbuild plugin to do something.
+An Rsbuild plugin to automatically inject polyfills for [Node.js builtin modules](https://nodejs.org/api/modules.html#built-in-modules) into the browser side.
 
 <p>
   <a href="https://npmjs.com/package/@rsbuild/plugin-node-polyfill">
@@ -9,6 +9,12 @@
   <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
 </p>
 
+## When to use
+
+Normally, we don't need to use Node builtin modules on the browser side. However, it is possible to use some Node builtin modules when the code will run on both the Node side and the browser side, and this plugin provides browser versions of polyfills for these Node builtin modules.
+
+By using the Node Polyfill plugin, polyfills for Node builtin modules are automatically injected into the browser-side, allowing you to use these modules on the browser side with confidence.
+
 ## Usage
 
 Install:

package/dist/index.cjs

@@ -20,10 +20,10 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// node_modules/.pnpm/tsup@8.0.2_postcss@8.4.38_typescript@5.5.2/node_modules/tsup/assets/cjs_shims.js
+// node_modules/.pnpm/tsup@8.0.2_postcss@8.4.39_typescript@5.5.2/node_modules/tsup/assets/cjs_shims.js
 var getImportMetaUrl, importMetaUrl;
 var init_cjs_shims = __esm({
-  "node_modules/.pnpm/tsup@8.0.2_postcss@8.4.38_typescript@5.5.2/node_modules/tsup/assets/cjs_shims.js"() {
+  "node_modules/.pnpm/tsup@8.0.2_postcss@8.4.39_typescript@5.5.2/node_modules/tsup/assets/cjs_shims.js"() {
     "use strict";
     getImportMetaUrl = () => typeof document === "undefined" ? new URL("file:" + __filename).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
     importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
@@ -191,14 +191,14 @@ function pluginNodePolyfill(options = {}) {
   return {
     name: PLUGIN_NODE_POLYFILL_NAME,
     setup(api) {
-      api.modifyBundlerChain(async (chain, { CHAIN_ID, isServer, bundler }) => {
+      api.modifyBundlerChain(async (chain, { isServer, bundler }) => {
         if (isServer) {
           return;
         }
         chain.resolve.fallback.merge(getResolveFallback(protocolImports));
         const provideGlobals = await getProvideGlobals(options.globals);
         if (Object.keys(provideGlobals).length) {
-          chain.plugin(CHAIN_ID.PLUGIN.NODE_POLYFILL_PROVIDE).use(bundler.ProvidePlugin, [provideGlobals]);
+          chain.plugin("node-polyfill-provide").use(bundler.ProvidePlugin, [provideGlobals]);
         }
         if (protocolImports) {
           const { ProtocolImportsPlugin: ProtocolImportsPlugin2 } = await Promise.resolve().then(() => (init_ProtocolImportsPlugin(), ProtocolImportsPlugin_exports));

package/dist/index.js

@@ -123,14 +123,14 @@ function pluginNodePolyfill(options = {}) {
   return {
     name: PLUGIN_NODE_POLYFILL_NAME,
     setup(api) {
-      api.modifyBundlerChain(async (chain, { CHAIN_ID, isServer, bundler }) => {
+      api.modifyBundlerChain(async (chain, { isServer, bundler }) => {
         if (isServer) {
           return;
         }
         chain.resolve.fallback.merge(getResolveFallback(protocolImports));
         const provideGlobals = await getProvideGlobals(options.globals);
         if (Object.keys(provideGlobals).length) {
-          chain.plugin(CHAIN_ID.PLUGIN.NODE_POLYFILL_PROVIDE).use(bundler.ProvidePlugin, [provideGlobals]);
+          chain.plugin("node-polyfill-provide").use(bundler.ProvidePlugin, [provideGlobals]);
         }
         if (protocolImports) {
           const { ProtocolImportsPlugin } = await import("./ProtocolImportsPlugin-HUSWFIAE.js");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rsbuild/plugin-node-polyfill",
-  "version": "1.0.1",
-  "repository": "https://github.com/rspack-contrib/rsbuild-plugin-template",
+  "version": "1.0.4",
+  "repository": "https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -53,7 +53,7 @@
   "devDependencies": {
     "@biomejs/biome": "^1.8.3",
     "@playwright/test": "^1.44.1",
-    "@rsbuild/core": "^0.7.10",
+    "@rsbuild/core": "^1.0.1-beta.10",
     "@types/node": "^20.14.1",
     "nano-staged": "^0.8.0",
     "playwright": "^1.44.1",
@@ -62,7 +62,7 @@
     "typescript": "^5.5.2"
   },
   "peerDependencies": {
-    "@rsbuild/core": "0.x || 1.x"
+    "@rsbuild/core": "1.x || ^1.0.1-beta.0"
   },
   "peerDependenciesMeta": {
     "@rsbuild/core": {