如何编写插件
Modern.js 支持通过自定义插件的方式来实现个性化功能。
实现插件
Modern.js 插件是一个对象,对象包含以下属性:
name
: 插件的名称,唯一标识符。setup
: 插件初始化函数,只会执行一次。setup 函数可以返回一个 Hooks 对象,Modern.js 会在特定的时机执行这些 Hooks。
const MyPlugin = {
name: 'my-plugin',
setup() {
// 执行一些初始化逻辑
const foo = '1';
// 返回一个 Hooks 对象
return {
afterBuild: () => {
// 在构建完成后执行逻辑
},
};
},
};
插件类型
使用 TypeScript 时,可以引入内置的 CliPlugin
类型,为插件提供正确的类型推导:
import type { CliPlugin } from '@modern-js/core';
const MyPlugin: CliPlugin = {
name: 'my-plugin',
setup() {
const foo = '1';
return {
afterBuild: () => {
// 在构建完成后执行逻辑
},
};
},
};
注
插件可以注册丰富的 Hooks,不同的 Hook 拥有不同的模型和运行规则,详见 Hook 模型。
插件配置项
建议将插件写成函数的形式,使插件能通过函数入参来接收配置项:
import type { CliPlugin } from '@modern-js/core';
type MyPluginOptions = {
foo: string;
};
const MyPlugin = (options: MyPluginOptions): CliPlugin => ({
name: 'my-plugin',
setup() {
console.log(options.foo);
},
});
插件 API
插件的 setup 函数会接收一个 api 入参,你可以调用 api 上提供的一些方法来获取到配置、应用上下文等信息。
import type { CliPlugin } from '@modern-js/core';
export default (): CliPlugin => ({
name: 'my-plugin',
setup(api) {
// 获取应用原始配置
const config = api.useConfigContext();
// 获取应用运行上下文
const appContext = api.useAppContext();
// 获取解析之后的最终配置
const resolvedConfig = api.useResolvedConfigContext();
},
});
插件 API 的详细说明,请参考 Plugin API。
异步 setup
CLI 插件的 setup 可以是一个异步函数,在初始化过程中执行异步逻辑。
import type { CliPlugin } from '@modern-js/core';
export default (): CliPlugin => ({
name: 'my-plugin',
async setup(api) {
await doSomething();
},
});
添加插件
自定义插件的使用方式可以查看:plugins (框架插件)。下面会介绍 Modern.js 中推荐的插件实现方法。
开发本地插件
本地插件推荐写在 config/plugin
目录下,并通过 export default
导出:
import type { CliPlugin } from '@modern-js/core';
export default (): CliPlugin => ({
name: 'my-plugin',
setup() {
// 插件初始化
},
});
然后在 modern.config.ts
中注册对应的插件:
import { defineConfig } from '@modern-js/app-tools';
import MyPlugin from './config/plugin/MyPlugin';
export default defineConfig({
plugins: [MyPlugin()],
});
在 npm 上发布插件
如果需要将 Modern.js 插件发布到 npm,推荐使用 Modern.js 中的模块工程方案来管理和构建,如果需要将它和使用项目管理在一起,则推荐使用 Modern.js 中的 Monorepo 工程方案管理。这里就简单地使用模块工程方案进行演示。
首先根据【项目创建】创建一个空的模块工程方案项目,调整 npm 包名称:
{
"name": "my-plugin"
...
}
然后新建对应的插件文件:
import type { CliPlugin } from '@modern-js/core';
export default (): CliPlugin => ({
name: 'my-plugin',
setup() {
// 插件初始化
},
});
发布之后,安装到需要使用的项目 pnpm add my-plugin
,这里以一个应用项目为例,然后在 modern.config.ts
中添加:
import { defineConfig } from '@modern-js/app-tools';
import MyPlugin from 'my-plugin';
export default defineConfig({
plugins: [MyPlugin()],
});
如果你发现目前 Modern.js 存在无法满足的场景,欢迎通过编写自定义插件的方式来一起建设 Modern.js 生态。