feat: allow to override the default react-refresh-loader (#70)

Author: n0th1ng-else

README.md

@@ -227,6 +227,21 @@ new ReactRefreshPlugin({
 });
 ```
 
+### reactRefreshLoader
+
+- Type: `string`
+- Default: `builtin:react-refresh-loader`
+
+Be default, the plugin uses `builtin:react-refresh-loader` loader implementation [from Rspack](https://github.com/web-infra-dev/rspack/tree/main/crates/rspack_loader_react_refresh) in order ot inject
+the React Refresh utilities into each module. `reactRefreshLoader` option allows to specify the loader, that implements 
+custom React Refresh instrumentation if needed.
+
+```js
+new ReactRefreshPlugin({
+    reactRefreshLoader: 'my-advanced-react-refresh-loader',
+});
+```
+
 ## Credits
 
 Thanks to the [react-refresh-webpack-plugin](https://github.com/pmmmwh/react-refresh-webpack-plugin) created by [@pmmmwh](https://github.com/pmmmwh), which inspires implement this plugin.

src/index.ts

@@ -42,8 +42,6 @@ class ReactRefreshRspackPlugin {
     return getRefreshRuntimePaths();
   }
 
-  static loader = 'builtin:react-refresh-loader';
-
   constructor(options: PluginOptions = {}) {
     this.options = normalizeOptions(options);
   }
@@ -104,7 +102,7 @@ class ReactRefreshRspackPlugin {
           // React Refresh should not be injected for asset modules as they are static resources
           not: ['url'],
         },
-        use: ReactRefreshRspackPlugin.loader,
+        use: this.options.reactRefreshLoader,
       });
     }
 

src/options.ts

@@ -85,6 +85,11 @@ export type PluginOptions = {
    * @default false
    */
   reloadOnRuntimeErrors?: boolean;
+  /**
+   * Allows to specify custom react-refresh loader
+   * @default "builtin:react-refresh-loader"
+   */
+  reactRefreshLoader?: string;
 };
 
 export interface NormalizedPluginOptions extends Required<PluginOptions> {
@@ -135,6 +140,7 @@ export function normalizeOptions(
   d(options, 'injectLoader', true);
   d(options, 'injectEntry', true);
   d(options, 'reloadOnRuntimeErrors', false);
+  d(options, 'reactRefreshLoader', 'builtin:react-refresh-loader');
   options.overlay = normalizeOverlay(options.overlay);
   return options as NormalizedPluginOptions;
 }

test/exports.spec.mts

@@ -1,6 +1,15 @@
 import DefaultExport, { ReactRefreshRspackPlugin } from '../exports/index.mjs';
 
 test('should allow to import from the package', () => {
-  expect(DefaultExport.loader).toBeTruthy();
+  const instance = new ReactRefreshRspackPlugin();
+  expect(instance.options.reactRefreshLoader).toBeTruthy();
+});
+
+test('should allow the default import from the package', () => {
+  const instance = new DefaultExport();
+  expect(instance.options.reactRefreshLoader).toBeTruthy();
+});
+
+test('default import picks the same plugin class', () => {
   expect(DefaultExport).toEqual(ReactRefreshRspackPlugin);
 });

test/exports.spec.ts

@@ -1,5 +1,6 @@
 const DefaultExport = require('../exports/index.cjs');
 
 test('should allow to require from the package', () => {
-  expect(DefaultExport.loader).toBeTruthy();
+  const instance = new DefaultExport();
+  expect(instance.options.reactRefreshLoader).toBeTruthy();
 });

test/fixtures/loader/index.js

@@ -0,0 +1 @@
+require('foo');

test/fixtures/loader/loader.js

@@ -0,0 +1,8 @@
+module.exports = function customLoader(source, sourceMap) {
+  const callback = this.async();
+
+  const injected = `/** TEST_LOADER */`;
+  const result = `${source}\n${injected}`;
+
+  callback(null, result, sourceMap);
+};