构建时共享插件

反馈

请在 环境 API 反馈讨论 中向我们提供反馈

参见 构建时共享插件。

影响范围：Vite 插件开发者

未来的默认变更

builder.sharedConfigBuild 首次引入于 v6.0。你可以将其设置为 true 来检查你的插件如何与共享配置一起工作。我们正在寻求关于在插件生态系统准备就绪后，在未来的主要版本中更改默认设置的反馈。

动机

对齐开发和构建插件管道。

迁移指南

为了能够在不同环境中共享插件，插件状态必须以当前环境为键。以下形式的插件将统计所有环境中转换的模块数量。

function CountTransformedModulesPlugin() {
  let transformedModules
  return {
    name: 'count-transformed-modules',
    buildStart() {
      transformedModules = 0
    },
    transform(id) {
      transformedModules++
    },
    buildEnd() {
      console.log(transformedModules)
    },
  }
}

如果我们需要分别统计每个环境中转换的模块数量，则需要维护一个 Map

function PerEnvironmentCountTransformedModulesPlugin() {
  const state = new Map<Environment, { count: number }>()
  return {
    name: 'count-transformed-modules',
    perEnvironmentStartEndDuringDev: true,
    buildStart() {
      state.set(this.environment, { count: 0 })
    }
    transform(id) {
      state.get(this.environment).count++
    },
    buildEnd() {
      console.log(this.environment.name, state.get(this.environment).count)
    }
  }
}

为了简化这种模式，Vite 导出了一个 perEnvironmentState 辅助函数

function PerEnvironmentCountTransformedModulesPlugin() {
  const state = perEnvironmentState<{ count: number }>(() => ({ count: 0 }))
  return {
    name: 'count-transformed-modules',
    perEnvironmentStartEndDuringDev: true,
    buildStart() {
      state(this).count = 0
    }
    transform(id) {
      state(this).count++
    },
    buildEnd() {
      console.log(this.environment.name, state(this).count)
    }
  }
}