用于插件的环境 API

实验性

这个 API 的初始版本在 Vite 5.1 中以 "Vite Runtime API" 的名字被引入。这份指南介绍了经过修订后的 API，被重新命名为环境 API（Environment API）。这个 API 将在 Vite 6 中作为实验性功能发布。你现在已经可以在最新的 [email protected] 版本中进行测试。

资料：

反馈讨论我们在此处收集新 API 的反馈。
环境 API PR 新 API 在此处被实现并进行了审查。

在参与测试这个提议的过程中，请与我们分享您的反馈。

在钩子中访问当前环境

在 Vite 6之前，由于只有两个环境（client 和 ssr），一个 ssr 布尔值足以在 Vite API 中识别当前环境。插件钩子在最后的选项参数中接收一个 ssr 布尔值，多个 API 也期望通过一个可选的 ssr 参数来正确地将模块关联到对应的环境（例如 server.moduleGraph.getModuleByUrl(url, { ssr })）。

随着可配置的环境出现，我们现在有了一种统一的方法来在插件中访问它们的选项和实例。插件钩子现在在其上下文中暴露 this.environment，以前期望 ssr 布尔值的 API 现在被限定到正确的环境（例如 environment.moduleGraph.getModuleByUrl(url)）。

Vite 服务器有一个共享的插件管道，但在处理模块时，它总是在给定环境的上下文中进行。environment 实例在插件上下文中可用。

插件可以使用 environment 实例根据环境的配置（可通过 environment.config 访问）来改变模块的处理方式。

  transform(code, id) {
    console.log(this.environment.config.resolve.conditions)
  }

使用钩子注册新环境

插件可以在 config 钩子中添加新环境（例如，为了有一个专门用于 RSC 的模块图）：

  config(config: UserConfig) {
    config.environments.rsc ??= {}
  }

一个空对象就足以注册环境，默认值则来自于根级别的环境配置。

使用钩子配置环境

当 config 钩子正在运行时，我们还不知道完整的环境列表，而且环境可以受到来自根级别环境配置的默认值或通过 config.environments 记录明确影响。插件应使用 config 钩子设置默认值。要配置每个环境，可以使用新的 configEnvironment 钩子。此钩子会为每个环境调用，并传入其部分解析的配置，包括最终默认值的解析。

  configEnvironment(name: string, options: EnvironmentOptions) {
    if (name === 'rsc') {
      options.resolve.conditions = // ...

`hotUpdate` 钩子

类型： (this: { environment: DevEnvironment }, options: HotUpdateOptions) => Array<EnvironmentModuleNode> | void | Promise<Array<EnvironmentModuleNode> | void>
查看： HMR API

hotUpdate 钩子允许插件为特定环境执行自定义的 HMR 更新处理。当一个文件发生变化时，会按照 server.environments 中的顺序为每个环境依次运行 HMR 算法，因此 hotUpdate 钩子会被多次调用。这个钩子会接收一个带有以下签名的上下文对象：

interface HotUpdateOptions {
  type: 'create' | 'update' | 'delete'
  file: string
  timestamp: number
  modules: Array<EnvironmentModuleNode>
  read: () => string | Promise<string>
  server: ViteDevServer
}

this.environment 是当前正在处理文件更新的模块执行环境。
modules 是由于文件更改而受影响的此环境中的模块的数组。它是一个数组，因为一个文件可能映射到多个服务的模块（例如 Vue SFCs）。
read 是一个异步读取函数，返回文件的内容。这是因为，在某些系统上，文件更改回调可能在编辑器完成文件更新之前触发得太快，直接的 fs.readFile 将返回空内容。传入的读取函数规范化了这种行为。

可以选择钩子用于：

过滤和缩小受影响的模块列表，使 HMR 更准确。

返回一个空数组并执行完全重载：

hotUpdate({ modules, timestamp }) {
  if (this.environment.name !== 'client')
    return

  // 手动使模块失效
  const invalidatedModules = new Set()
  for (const mod of modules) {
    this.environment.moduleGraph.invalidateModule(
      mod,
      invalidatedModules,
      timestamp,
      true
    )
  }
  this.environment.hot.send({ type: 'full-reload' })
  return []
}

返回一个空数组并通过向客户端发送自定义事件来执行完全自定义的 HMR 处理：

hotUpdate() {
  if (this.environment.name !== 'client')
    return

  this.environment.hot.send({
    type: 'custom',
    event: 'special-update',
    data: {}
  })
  return []
}

客户端代码应使用 HMR API 注册相应的处理程序（这可以通过相同插件的 transform 钩子注入）：

if (import.meta.hot) {
  import.meta.hot.on('special-update', (data) => {
    // 执行自定义更新
  })
}

基于环境的插件

插件可以使用 applyToEnvironment 函数来定义它适用的环境。

const UnoCssPlugin = () => {
  // 共享的全局状态
  return {
    buildStart() {
      // 使用 WeakMap<Environment,Data> 初始化每个环境状态
      // 使用 this.environment
    },
    configureServer() {
      // 正常使用全局钩子
    },
    applyToEnvironment(environment) {
      // 如果此插件应在此环境中激活，则返回 true
      // 或返回一个新插件来替代它。
      // 如果不使用这个 hook，则插件在所有环境中都是激活的
    },
    resolveId(id, importer) {
      // 只对此插件适用的环境进行调用
    },
  }
}

如果一个插件没有环境感知功能，并且其状态没有基于当前环境进行区分，applyToEnvironment 钩子可以轻松地将其设置为针对每个环境工作。

import { nonShareablePlugin } from 'non-shareable-plugin'

export default defineConfig({
  plugins: [
    {
      name: 'per-environment-plugin',
      applyToEnvironment(environment) {
        return nonShareablePlugin({ outputName: environment.name })
      },
    },
  ],
})

Vite 输出了一个 perEnvironmentPlugin 助手，以简化这些不需要其他钩子的情况：

import { nonShareablePlugin } from 'non-shareable-plugin'

export default defineConfig({
  plugins: [
    perEnvironmentPlugin('per-environment-plugin', (environment) =>
      nonShareablePlugin({ outputName: environment.name }),
    ),
  ],
})

构建钩子中的环境

与开发期间一样，插件钩子在构建期间也接收环境实例，取代了 ssr 布尔值。这同样适用于 renderChunk、generateBundle 和其他仅在构建时使用的钩子。

构建期间的共享插件

在 Vite 6 之前，插件管道在开发和构建期间的工作方式不同：

开发期间： 插件是共享的
构建期间： 插件对每个环境是隔离的（在不同的进程中：vite build 然后 vite build --ssr）。

这迫使框架通过写入文件系统的清单文件在 client 构建和 ssr 构建之间共享状态。在 Vite 6 中，我们现在在单个进程中构建所有环境，因此插件管道和环境间通信的方式可以与开发对齐。

在未来的主要版本（Vite 7 或 8）中，我们的目标是完全对齐：

在开发和构建期间： 插件是共享的，并可以根据环境进行过滤

在构建期间还会共享一个单一的 ResolvedConfig 实例，允许在整个应用构建过程中进行缓存，类似于我们在开发期间使用 WeakMap<ResolvedConfig, CachedData> 的方式。

对于 Vite 6，我们需要做一个较小的改动以保持向后兼容。生态系统插件当前使用 config.build 而不是 environment.config.build 来访问配置，因此我们需要默认为每个环境创建一个新的 ResolvedConfig。项目可以通过设置 builder.sharedConfigBuild 为 true 来选择共享完整的配置和插件管道。

此选项最初仅适用于一小部分项目，因此插件作者可以通过将 sharedDuringBuild 标志设置为 true 来选择特定插件在构建期间共享。这可以很容易地共享常规插件的状态：

function myPlugin() {
  // 在开发和构建中的所有环境之间共享状态
  const sharedState = ...
  return {
    name: 'shared-plugin',
    transform(code, id) { ... },

    // 选择在所有环境中使用单个实例
    sharedDuringBuild: true,
  }
}

用于插件的环境 API ​

在钩子中访问当前环境 ​

使用钩子注册新环境 ​

使用钩子配置环境 ​

hotUpdate 钩子 ​

基于环境的插件 ​

构建钩子中的环境 ​

构建期间的共享插件 ​