编写 Runtime 插件

Farm 运行时插件是一个纯 JavaScript 对象，它定义了一组钩子来增强 Farm 运行时。例子：

上面是一个支持 Farm 的 HMR 的运行时插件。要点：

运行时插件入口文件应该 导出 定义一组钩子的默认对象。例如 导出默认 <Plugin>{/*...*/}
需要name来标识插件，确保name是唯一的
hook 是在导出对象中定义的方法。

备注

有关上述示例的完整实现，请参阅 @farmfe/runtime-plugin-hmr。

注意事项

您应该使您的运行时插件尽可能简单。你不应该：

使用node_modules中的大依赖，这会让你的 Farm 运行时插件非常大，可能会严重影响运行时性能。
使用 top level await 等新功能，因为这些与运行时相关的功能很难针对低级别运行时进行 polyfill。

强烈建议确保您的运行时插件尽可能小且简单。

提示

import.meta.xxx 将被编译为 module.meta.xxx，您可以在运行时插件中向 module.meta 添加值来增强 import.meta。例如， module.meta.hot = createHotContext(module.id, hmrClient) 使 import.meta.hot 可用。

惯例

Farm 运行时插件名称应以 farm-runtime-plugin 为前缀，例如 farm-runtime-plugin-xxx 。

备注

plugin.name 和 package name（仅当您将插件发布为包时）都应该加上前缀。

使用 Runtime 插件

使用 compilation.runtime.plugins 为您的项目配置运行时插件：

您可以通过 3 种方式配置运行时插件项：

相对路径：相对于root的路径，例如./src/my-plugin1.ts将尝试从<root>/src/my-plugin1.ts加载插件。
绝对路径：例如/root/project/src/my-plugin2.ts。（在 Windows 上绝对路径应为 C:\project\src\my-plugin2.ts ）。
包名称：Farm将尝试从node_modules加载此包，例如@scope/plugin-package-from-node-modules。