PluginOption对象是vite插件选项的接口,包含以下属性:
-
name: string。插件的名称字符串,必需项。
-
apply: (options: any) => any。插件处理函数,必需项。该函数有一个参数options,表示插件配置选项。
-
config?: (config: UserConfig, env: Mode) => UserConfig。Vite的配置,在合并和解析模式下提供 Vite配置对象和当前环境 模式。
-
enforce?: "pre" | "post"。指示 Vite 应该在何时执行插件。如果设置为“pre”,则该插件将在其他插件执行之前执行。如果设置为“post”,则该插件将在其他插件执行之后执行。默认为 undefined。
-
apply?: "serve" | "build"。指示插件应该在何时应用。如果设置为“serve”,插件将仅在 dev server 中应用。如果设置为“build”,插件将仅在生产构建过程中应用。默认为“serve+build”,即所有情况下均应用插件。
-
handleHotUpdate?: (ctx: PluginContext, file: string) => void。用于处理热更新的函数,即在热更新期间运行插件。