BuilderPlugin[]
[]
用于配置 Modern.js Builder 构建插件。
Modern.js Builder 是 Modern.js 底层的构建工具,请阅读 构建能力 了解相关背景。
如果你想了解 Builder 插件的编写方式,可以参考 Modern.js Builder - 插件系统。
该选项用于配置 Modern.js Builder 构建插件,如果你需要配置其他类型的插件,请选择对应的配置方式:
大部分场景下,我们推荐你使用 Modern.js 框架插件,框架插件可以通过 plugins 字段进行注册。因为框架插件提供的 API 更丰富、能力更强,而 Builder 插件提供的 API 只能用于构建场景。
当你需要引用一些现有的 Builder 插件(并且在 Modern.js 中没有相关能力),或是在不同的框架之间复用 Builder 插件时,你可以使用 builderPlugins
字段进行注册。
下面是 Builder 插件的使用示例。
使用 npm 上的插件,需要通过包管理器安装插件,并通过 import 引入。
import { myBuilderPlugin } from 'my-builder-plugin';
export default defineConfig({
builderPlugins: [myBuilderPlugin()],
});
使用本地代码仓库中的插件,直接通过相对路径 import 引入即可。
import { myBuilderPlugin } from './plugin/myBuilderPlugin';
export default defineConfig({
builderPlugins: [myBuilderPlugin()],
});
如果插件提供了一些自定义的配置项,可以通过插件函数的参数传入配置。
import { myBuilderPlugin } from 'my-builder-plugin';
export default defineConfig({
builderPlugins: [
myBuilderPlugin({
foo: 1,
bar: 2,
}),
],
});