feat(plugin-preact): add include and exclude options (#3835)

Author: chenjiahan

e2e/cases/preact/basic/rsbuild.config.ts

@@ -1,5 +1,13 @@
 import { pluginPreact } from '@rsbuild/plugin-preact';
 
 export default {
-  plugins: [pluginPreact()],
+  plugins: [
+    pluginPreact({
+      exclude: [
+        /node_modules/,
+        // exclude Rsbuild internal HMR client
+        /packages\/core\/dist/,
+      ],
+    }),
+  ],
 };

e2e/cases/preact/prefresh/rsbuild.config.ts

@@ -1,5 +1,13 @@
 import { pluginPreact } from '@rsbuild/plugin-preact';
 
 export default {
-  plugins: [pluginPreact()],
+  plugins: [
+    pluginPreact({
+      exclude: [
+        /node_modules/,
+        // exclude Rsbuild internal HMR client
+        /packages\/core\/dist/,
+      ],
+    }),
+  ],
 };

packages/plugin-preact/src/index.ts

@@ -14,6 +14,18 @@ export type PluginPreactOptions = {
    * @default true
    */
   prefreshEnabled?: boolean;
+  /**
+   * Include files to be processed by the `@rspack/plugin-preact-refresh` plugin.
+   * The value is the same as the `rule.test` option in Rspack.
+   * @default /\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/
+   */
+  include?: Rspack.RuleSetCondition;
+  /**
+   * Exclude files from being processed by the `@rspack/plugin-preact-refresh` plugin.
+   * The value is the same as the `rule.exclude` option in Rspack.
+   * @default /[\\/]node_modules[\\/]/
+   */
+  exclude?: Rspack.RuleSetCondition;
 };
 
 export const PLUGIN_PREACT_NAME = 'rsbuild:preact';
@@ -25,6 +37,8 @@ export const pluginPreact = (
 
   setup(api) {
     const options = {
+      include: /\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/,
+      exclude: /[\\/]node_modules[\\/]/,
       prefreshEnabled: true,
       reactAliasesEnabled: true,
       ...userOptions,
@@ -101,20 +115,14 @@ export const pluginPreact = (
         '@rspack/plugin-preact-refresh'
       );
 
-      const SCRIPT_REGEX = /\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/;
       const preactPath = require.resolve('preact', {
         paths: [api.context.rootPath],
       });
 
       chain.plugin('preact-refresh').use(PreactRefreshPlugin, [
         {
-          include: [SCRIPT_REGEX],
-          exclude: [
-            /node_modules/,
-            // exclude Rsbuild internal HMR client
-            // TODO: use better way to exclude
-            /packages\/core\/dist/,
-          ],
+          include: options.include,
+          exclude: options.exclude,
           preactPath,
         },
       ]);

website/docs/en/plugins/list/plugin-preact.mdx

@@ -60,3 +60,31 @@ pluginPreact({
   prefreshEnabled: false,
 });
 ```
+
+### include
+
+Include files to be processed by the [@rspack/plugin-preact-refresh](https://github.com/rspack-contrib/rspack-plugin-preact-refresh) plugin. The value is the same as the `rule.test` option in Rspack.
+
+- **Type:** [RuleSetCondition](https://rspack.dev/zh/config/module#condition)
+- **Default:** `/\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/`
+- **Version:** `>= v1.1.0`
+
+```ts
+pluginPreact({
+  include: [/\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/, /some-other-module/],
+});
+```
+
+### exclude
+
+Exclude files from being processed by the [@rspack/plugin-preact-refresh](https://github.com/rspack-contrib/rspack-plugin-preact-refresh) plugin. The value is the same as the `rule.exclude` option in Rspack.
+
+- **Type:** [RuleSetCondition](https://rspack.dev/zh/config/module#condition)
+- **Default:** `/[\\/]node_modules[\\/]/`
+- **Version:** `>= v1.1.0`
+
+```ts
+pluginPreact({
+  exclude: [/[\\/]node_modules[\\/]/, /some-other-module/],
+});
+```

website/docs/zh/config/source/exclude.mdx

@@ -1,6 +1,6 @@
 # source.exclude
 
-- **类型：** [RuleSetCondition[]](https://rspack.dev/zh/config/module#condition)
+- **类型：** [RuleSetCondition](https://rspack.dev/zh/config/module#condition)
 - **默认值：** `[]`
 
 指定不需要编译的 JavaScript/TypeScript 文件。用法与 Rspack 中的 [Rule.exclude](https://rspack.dev/zh/config/module#ruleexclude) 一致，支持传入字符串或正则表达式来匹配模块的路径。

website/docs/zh/config/source/include.mdx

@@ -1,6 +1,6 @@
 # source.include
 
-- **类型：** [RuleSetCondition[]](https://rspack.dev/zh/config/module#condition)
+- **类型：** [RuleSetCondition](https://rspack.dev/zh/config/module#condition)
 - **默认值：**
 
 ```ts

website/docs/zh/plugins/list/plugin-preact.mdx

@@ -60,3 +60,31 @@ pluginPreact({
   prefreshEnabled: false,
 });
 ```
+
+### include
+
+指定要由 [@rspack/plugin-preact-refresh](https://github.com/rspack-contrib/rspack-plugin-preact-refresh) 插件处理的文件。这个值与 Rspack 中的 `rule.test` 选项相同。
+
+- **类型：** [RuleSetCondition](https://rspack.dev/zh/config/module#condition)
+- **默认值：** `/\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/`
+- **版本：** `>= v1.1.0`
+
+```ts
+pluginPreact({
+  include: [/\.(?:js|jsx|mjs|cjs|ts|tsx|mts|cts)$/, /some-other-module/],
+});
+```
+
+### exclude
+
+排除 [@rspack/plugin-preact-refresh](https://github.com/rspack-contrib/rspack-plugin-preact-refresh) 插件处理的文件。这个值与 Rspack 中的 `rule.exclude` 选项相同。
+
+- **类型：** [RuleSetCondition](https://rspack.dev/zh/config/module#condition)
+- **默认值：** `/[\\/]node_modules[\\/]/`
+- **版本：** `>= v1.1.0`
+
+```ts
+pluginPreact({
+  exclude: [/[\\/]node_modules[\\/]/, /some-other-module/],
+});
+```