builderPlugins 构建插件#

• 类型： RsbuildPlugin[]
• 默认值： []

用于配置 Rsbuild 构建插件。

Rsbuild 是 Modern.js 底层的构建工具，请阅读 构建能力 了解相关背景。

如果你想了解 Rsbuild 插件的编写方式，可以参考 Rsbuild - 插件系统。

注意事项#

该选项用于配置 Rsbuild 构建插件，如果你需要配置其他类型的插件，请选择对应的配置方式：

• 配置 Modern.js 框架插件，请使用 plugins 配置项。
• 配置 Rspack 或 webpack 插件，请使用 tools.bundlerChain 配置项。
• 配置 Babel 插件，请使用 tools.babel 配置项。

何时使用#

大部分场景下，我们推荐你使用 Modern.js 框架插件，框架插件可以通过 plugins 字段进行注册。因为框架插件提供的 API 更丰富、能力更强，而 Rsbuild 插件提供的 API 只能用于构建场景。

当你需要引用一些现有的 Rsbuild 插件（并且在 Modern.js 中没有相关能力），或是在不同的框架之间复用 Rsbuild 插件时，你可以使用 builderPlugins 字段进行注册。

示例#

下面是 Rsbuild 插件的使用示例。

使用 npm 上的插件#

使用 npm 上的插件，需要通过包管理器安装插件，并通过 import 引入。

import { myRsbuildPlugin } from 'my-rsbuild-plugin';

export default defineConfig({
  builderPlugins: [myRsbuildPlugin()],
});

使用本地插件#

使用本地代码仓库中的插件，直接通过相对路径 import 引入即可。

import { myRsbuildPlugin } from './plugin/myRsbuildPlugin';

export default defineConfig({
  builderPlugins: [myRsbuildPlugin()],
});

插件配置项#

如果插件提供了一些自定义的配置项，可以通过插件函数的参数传入配置。

import { myRsbuildPlugin } from 'my-rsbuild-plugin';

export default defineConfig({
  builderPlugins: [
    myRsbuildPlugin({
      foo: 1,
      bar: 2,
    }),
  ],
});