简体中文

Plugin Core

本章节描述了 Rsbuild 插件核心的类型定义和 API。

RsbuildPlugin

插件对象的类型，插件对象包含以下属性：

name：插件的名称，唯一标识符。
setup：插件逻辑的主入口函数，可以是一个异步函数。该函数仅会在初始化插件时执行一次。插件 API 对象上挂载了提供给插件使用的上下文数据、工具函数和注册生命周期钩子的函数，关于生命周期钩子的完整介绍，请阅读 Plugin Hooks 章节。
pre：声明前置插件的名称，这些插件会在当前插件之前执行。
post：声明后置插件的名称，这些插件会在当前插件之后执行。
remove：声明需要移除的插件，可以传入插件 name 的数组。

type RsbuildPlugin = {
  name: string;
  pre?: string[];
  post?: string[];
  remove?: string[];
  setup: (api: RsbuildPluginAPI) => Promise<void> | void;
};

你可以从 @rsbuild/core 中导入该类型：

import type { RsbuildPlugin } from '@rsbuild/core';

export default (): RsbuildPlugin => ({
  name: 'plugin-foo',

  pre: ['plugin-bar'],

  setup: (api) => {
    api.onAfterBuild(() => {
      console.log('after build!');
    });
  },
});

前置插件

默认情况下，插件会按照添加顺序依次执行，通过 pre 字段可以声明前置执行的插件。

比如有下面两个插件：

const pluginFoo = {
  name: 'plugin-foo',
};

const pluginBar = {
  name: 'plugin-bar',
  pre: ['plugin-foo'],
};

Bar 插件在 pre 字段中配置了 Foo 插件，因此 Foo 插件一定会在 Bar 插件之前执行。

后置插件

同样的，通过 post 字段可以声明后置执行的插件。

const pluginFoo = {
  name: 'plugin-foo',
};

const pluginBar = {
  name: 'plugin-bar',
  post: ['plugin-foo'],
};

Bar 插件在 post 字段中配置了 Foo 插件，因此 Foo 插件一定会在 Bar 插件之后执行。

移除插件

通过 remove 字段可以在一个插件中移除其他插件。

const pluginFoo = {
  name: 'plugin-foo',
};

const pluginBar = {
  name: 'plugin-bar',
  remove: ['plugin-foo'],
};

比如同时注册上述的 Foo 和 Bar 插件，由于 Bar 插件声明 remove 了 Foo 插件，因此 Foo 插件不会生效。

api.context

api.context 是一个只读对象，提供一些上下文信息。

api.context 的内容与 rsbuild.context 完全一致，请参考 rsbuild.context。

示例：

const pluginFoo = () => ({
  setup(api) {
    console.log(api.context.distPath);
  },
});

api.getRsbuildConfig

获取 Rsbuild 配置。

类型：

type GetRsbuildConfig = {
  (): Readonly<RsbuildConfig>;
  (type: 'original' | 'current'): Readonly<RsbuildConfig>;
  (type: 'normalized'): NormalizedConfig;
};

参数：

你可以通过 type 参数来指定读取的 Rsbuild 配置类型：

// 获取用户定义的原始 Rsbuild 配置。
getRsbuildConfig('original');

// 获取当前的 Rsbuild 配置。
// 在 Rsbuild 的不同执行阶段，该配置的内容会发生变化。
// 比如 `modifyRsbuildConfig` 钩子执行后会修改当前 Rsbuild 配置的内容。
getRsbuildConfig('current');

// 获取归一化后的 Rsbuild 配置。
// 该方法必须在 `modifyRsbuildConfig` 钩子执行完成后才能被调用。
// 等价于 `getNormalizedConfig` 方法。
getRsbuildConfig('normalized');

示例：

const pluginFoo = () => ({
  setup(api) {
    const config = api.getRsbuildConfig();
    console.log(config.html?.title);
  },
});

api.getNormalizedConfig

获取归一化后的 Rsbuild 配置，该方法必须在 modifyRsbuildConfig 钩子执行完成后才能被调用。

相较于 getRsbuildConfig 方法，该方法返回的配置经过了归一化处理，配置的类型定义会得到收敛，比如 config.html 的 undefined 类型将被移除。

推荐优先使用该方法获取配置。

类型：

function GetNormalizedConfig(): Readonly<NormalizedConfig>;

示例：

const pluginFoo = () => ({
  setup(api) {
    const config = api.getNormalizedConfig();
    console.log(config.html.title);
  },
});

api.isPluginExists

判断某个插件是否已经被注册。

类型：

function IsPluginExists(pluginName: string): boolean;

示例：

export default () => ({
  setup: (api) => {
    console.log(api.isPluginExists('plugin-foo'));
  },
});

api.getHTMLPaths

获取所有 HTML 产物的路径信息。

该方法会返回一个对象，对象的 key 为 entry 名称，value 为 HTML 文件在产物目录下的相对路径。

类型：

function GetHTMLPaths(): Record<string, string>;

示例：

const pluginFoo = () => ({
  setup(api) {
    api.modifyRspackConfig(() => {
      const htmlPaths = api.getHTMLPaths();
      console.log(htmlPaths); // { index: 'index.html' };
    });
  },
});

api.expose

用于插件间通信。

api.export 可以显式暴露当前插件的一些属性或方法，其他插件可以通过 api.useExposed 来获取这些 API。

类型：

/**
 * @param id 唯一标识符，使用 Symbol 可以避免命名冲突
 * @param api 需要暴露的属性或方法，建议使用对象格式
 */
function expose<T = any>(id: string | symbol, api: T): void;

示例：

const pluginParent = () => ({
  name: 'plugin-parent',
  setup(api) {
    api.expose('plugin-parent', {
      value: 1,
      double: (val: number) => val * 2,
    });
  },
});

api.useExposed

用于插件间通信。

api.useExposed 可以获取到其他插件暴露的属性或方法。

类型：

/**
 * @param id 唯一标识符
 * @returns 获取的属性或方法
 */
function useExposed<T = any>(id: string | symbol): T | undefined;

示例：

const pluginChild = () => ({
  name: 'plugin-child',
  pre: ['plugin-parent'],
  setup(api) {
    const parentApi = api.useExposed('plugin-parent');
    if (parentApi) {
      console.log(parentApi.value); // -> 1
      console.log(parentApi.double(1)); // -> 2
    }
  },
});

标识符

你可以使用 Symbol 作为唯一标识符，从而避免潜在的命名冲突：

// pluginParent.ts
export const PARENT_API_ID = Symbol('plugin-parent');

const pluginParent = () => ({
  name: 'plugin-parent',
  setup(api) {
    api.expose(PARENT_API_ID, {
      // some api
    });
  },
});

// pluginChild.ts
import { PARENT_API_ID } from './pluginParent';

const pluginChild = () => ({
  name: 'plugin-child',
  setup(api) {
    const parentApi = api.useExposed(PARENT_API_ID);
    if (parentApi) {
      console.log(parentApi);
    }
  },
});

类型声明

你可以通过函数的泛型来声明类型：

// pluginParent.ts
export type ParentAPI = {
  // ...
};

// pluginChild.ts
import type { ParentAPI } from './pluginParent';

const pluginChild = () => ({
  name: 'plugin-child',
  setup(api) {
    const parentApi = api.useExposed<ParentAPI>(PARENT_API_ID);
    if (parentApi) {
      console.log(parentApi);
    }
  },
});

执行顺序

在进行插件间通信时，你需要留意插件的执行顺序。

比如，在上面的示例中，如果 pluginParent 未注册，或者注册顺序晚于 pluginChild，那么 api.useExposed('plugin-parent') 会返回一个 undefined。

你可以使用插件对象的 pre、post 选项，以及插件 hook 的 order 选项来保证顺序是正确的。

Plugin Core#

RsbuildPlugin#

前置插件#

后置插件#

移除插件#

api.context#

api.getRsbuildConfig#

api.getNormalizedConfig#

api.isPluginExists#

api.getHTMLPaths#

api.expose#

api.useExposed#

标识符#

类型声明#

执行顺序#