@rspack/plugin-react-refresh 0.3.4 → 0.3.5

package/client/reactRefreshEntry.js

@@ -1,4 +1,52 @@
-const RefreshRuntime = require("react-refresh/runtime");
+/**
+ * The following code is modified based on
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/0b960573797bf38926937994c481e4fec9ed8aa6/client/ReactRefreshEntry.js
+ *
+ * MIT Licensed
+ * Author Michael Mok
+ * Copyright (c) 2019 Michael Mok
+ * https://github.com/pmmmwh/react-refresh-webpack-plugin/blob/0b960573797bf38926937994c481e4fec9ed8aa6/LICENSE
+ */
 
-RefreshRuntime.injectIntoGlobalHook(self);
-self.$RefreshSig$ = RefreshRuntime.createSignatureFunctionForTransform;
+var RefreshRuntime = require("react-refresh/runtime");
+var safeThis = (function () {
+	// copied from core-js-pure/features/global-this
+	"use strict";
+
+	var check = function (it) {
+		return it && it.Math == Math && it;
+	};
+
+	// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028
+	// eslint-disable-next-line es/no-global-this -- safe
+	return (
+		check(typeof globalThis == "object" && globalThis) ||
+		check(typeof window == "object" && window) ||
+		// eslint-disable-next-line no-restricted-globals -- safe
+		check(typeof self == "object" && self) ||
+		check(typeof __webpack_require__.g == "object" && __webpack_require__.g) ||
+		// eslint-disable-next-line no-new-func -- fallback
+		(function () {
+			return this;
+		})() ||
+		this ||
+		Function("return this")()
+	);
+})();
+
+if (process.env.NODE_ENV !== "production") {
+	if (typeof safeThis !== "undefined") {
+		var $RefreshInjected$ = "__reactRefreshInjected";
+		// Only inject the runtime if it hasn't been injected
+		if (!safeThis[$RefreshInjected$]) {
+			RefreshRuntime.injectIntoGlobalHook(safeThis);
+
+			// Empty implementation to avoid "ReferenceError: variable is not defined" in module which didn't pass builtin:react-refresh-loader
+			safeThis.$RefreshSig$ = () => type => type;
+			safeThis.$RefreshReg$ = () => {};
+
+			// Mark the runtime as injected to prevent double-injection
+			safeThis[$RefreshInjected$] = true;
+		}
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/plugin-react-refresh",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "license": "MIT",
   "description": "React refresh plugin for rspack",
   "main": "src/index.js",
@@ -24,10 +24,13 @@
     "directory": "packages/rspack-plugin-react-refresh"
   },
   "dependencies": {
-    "@pmmmwh/react-refresh-webpack-plugin": "0.5.10"
+    "@pmmmwh/react-refresh-webpack-plugin": "0.5.10",
+    "schema-utils": "^4.0.0"
   },
   "devDependencies": {
-    "react-refresh": "0.14.0"
+    "react-refresh": "0.14.0",
+    "@rspack/core": "0.3.5",
+    "@rspack/plugin-react-refresh": "0.3.5"
   },
   "peerDependencies": {
     "react-refresh": ">=0.10.0 <1.0.0"
@@ -37,7 +40,14 @@
       "optional": true
     }
   },
+  "jest": {
+    "watchPathIgnorePatterns": [
+      "<rootDir>/dist",
+      "<rootDir>/tests/dist"
+    ],
+    "testEnvironment": "../../scripts/test/patch-node-env.cjs"
+  },
   "scripts": {
-    "test": "echo success"
+    "test": "jest --runInBand"
   }
 }

package/src/index.js

@@ -1,6 +1,11 @@
 const path = require("path");
+const { validate: validateOptions } = require("schema-utils");
+
 const reactRefreshPath = require.resolve("../client/reactRefresh.js");
 const reactRefreshEntryPath = require.resolve("../client/reactRefreshEntry.js");
+const schema = require("./options.json");
+const { normalizeOptions } = require("./options");
+
 const refreshUtilsPath = require.resolve(
 	"@pmmmwh/react-refresh-webpack-plugin/lib/runtime/RefreshUtils",
 	{
@@ -13,12 +18,32 @@ const refreshRuntimeDirPath = path.dirname(
 	})
 );
 const runtimePaths = [
+	reactRefreshEntryPath,
 	reactRefreshPath,
 	refreshUtilsPath,
 	refreshRuntimeDirPath
 ];
 
+/**
+ * @typedef {Object} Options
+ * @property {(string | RegExp | (string | RegExp)[] | null)=} include included resourcePath for loader
+ * @property {(string | RegExp | (string | RegExp)[] | null)=} exclude excluded resourcePath for loader
+ */
+
 module.exports = class ReactRefreshRspackPlugin {
+	/**
+	 * @param {Options} options
+	 */
+	constructor(options = {}) {
+		validateOptions(schema, options, {
+			name: "React Refresh Rspack Plugin",
+			baseDataPath: "options"
+		});
+		/**
+		 * @type {Options}
+		 */
+		this.options = normalizeOptions(options);
+	}
 	apply(compiler) {
 		new compiler.webpack.EntryPlugin(compiler.context, reactRefreshEntryPath, {
 			name: undefined
@@ -27,9 +52,14 @@ module.exports = class ReactRefreshRspackPlugin {
 			$ReactRefreshRuntime$: reactRefreshPath
 		}).apply(compiler);
 
-		compiler.options.module.rules.push({
-			include: runtimePaths,
-			type: "js"
+		compiler.options.module.rules.unshift({
+			include: this.options.include,
+			exclude: {
+				or: [this.options.exclude, [...runtimePaths]].filter(Boolean)
+			},
+			use: "builtin:react-refresh-loader"
 		});
 	}
 };
+
+module.exports.deprecated_runtimePaths = runtimePaths;

package/src/options.js

@@ -0,0 +1,17 @@
+const d = (object, property, defaultValue) => {
+	if (
+		typeof object[property] === "undefined" &&
+		typeof defaultValue !== "undefined"
+	) {
+		object[property] = defaultValue;
+	}
+	return object[property];
+};
+
+const normalizeOptions = function (options) {
+	d(options, "exclude", /node_modules/i);
+	d(options, "include", /\.([cm]js|[jt]sx?|flow)$/i);
+	return options;
+};
+
+module.exports = { normalizeOptions };

package/src/options.json

@@ -0,0 +1,33 @@
+{
+  "additionalProperties": false,
+  "type": "object",
+  "definitions": {
+    "Path": { "type": "string" },
+    "MatchCondition": {
+      "anyOf": [
+        { "instanceof": "RegExp" },
+        { "$ref": "#/definitions/Path" },
+        { "type": "null" }
+      ]
+    },
+    "MatchConditions": {
+      "type": "array",
+      "items": { "$ref": "#/definitions/MatchCondition" },
+      "minItems": 1
+    }
+  },
+  "properties": {
+    "exclude": {
+      "anyOf": [
+        { "$ref": "#/definitions/MatchCondition" },
+        { "$ref": "#/definitions/MatchConditions" }
+      ]
+    },
+    "include": {
+      "anyOf": [
+        { "$ref": "#/definitions/MatchCondition" },
+        { "$ref": "#/definitions/MatchConditions" }
+      ]
+    }
+  }
+}