API

cloudflare 插件应包含在 Vite plugins 数组中：

import { defineConfig } from "vite";
import { cloudflare } from "@cloudflare/vite-plugin";

export default defineConfig({
	plugins: [cloudflare()],
});

它接受可选的 PluginConfig 参数。

• configPath stringoptional

  指向入口 Worker 配置文件的可选路径。

  对于入口 Worker，插件按以下顺序解析配置路径：

  1. configPath
  2. CLOUDFLARE_VITE_WRANGLER_CONFIG_PATH（通常由框架或其他外部工具设置）
  3. 应用程序根目录中的 wrangler.jsonc、wrangler.json 或 wrangler.toml

  这适用于 vite dev 和 vite build。

  有关 Worker 配置的更多信息，请参阅配置。

• config WorkerConfigCustomizer<true>optional

  以编程方式自定义或覆盖 Worker 配置。 接受部分配置对象或接收当前配置的函数。

  在任何配置文件加载后应用。可用于覆盖值、修改现有配置，或完全在代码中定义 Worker。

  详细信息请参阅编程式配置。

• viteEnvironment { name?: string; childEnvironments?: string[] }optional

  可选的 Vite 环境选项。 默认情况下，环境名称是 Worker 名称，其中 - 字符替换为 _。 在此设置名称将覆盖此行为。 典型用例是设置 viteEnvironment: { name: "ssr" } 以将 Worker 应用于 SSR 环境。

  childEnvironments 选项用于通过 @vitejs/plugin-rsc ↗ 及基于它构建的框架支持 React Server Components。 这允许在单个 Worker 内嵌入具有独立模块图的附加环境。

  更多信息请参阅 Vite 环境。

• persistState boolean | { path: string }optional

  状态持久化的可选覆盖。 默认情况下，状态持久化到 .wrangler/state。 可以提供自定义 path，或者通过将值设置为 false 来禁用持久化。

• inspectorPort number | falseoptional

  调试 Worker 的可选覆盖。 默认情况下，调试检查器已启用并在端口 9229 上监听。 可以提供自定义端口，或者将此设置为 false 以禁用调试检查器。

  更多信息请参阅调试。

• tunnel boolean | { name?: string; autoStart?: boolean }optional

  通过 Cloudflare Tunnel 暴露本地开发服务器。

  提供对象以配置命名隧道或控制隧道是否自动启动。按 t + Enter 启动或关闭隧道。如果希望 Vite 启动时打开隧道，请将 tunnel.autoStart 设置为 true。

  import { defineConfig } from "vite";
  import { cloudflare } from "@cloudflare/vite-plugin";
  
  export default defineConfig({
  	plugins: [
  		cloudflare({
  			tunnel: { name: "my-tunnel" },
  		}),
  	],
  });

  import { defineConfig } from "vite";
  import { cloudflare } from "@cloudflare/vite-plugin";
  
  export default defineConfig({
  	plugins: [
  		cloudflare({
  			tunnel: { name: "my-tunnel" },
  		}),
  	],
  });

  更多信息请参阅共享本地开发服务器。

• auxiliaryWorkers Array<AuxiliaryWorkerConfig>optional

  可选的辅助 Worker 数组。 辅助 Worker 是应用程序中使用的附加 Worker。 可以使用服务绑定（service bindings） 从主（入口）Worker 调用辅助 Worker。 所有请求都通过入口 Worker 路由。 在构建期间，每个 Worker 输出到 dist 的单独子目录。

• remoteBindings booleanoptional

  是否启用远程绑定（remote bindings）。默认为 true。

辅助 Worker 需要 configPath、config 选项或两者兼有。 CLOUDFLARE_VITE_WRANGLER_CONFIG_PATH 仅适用于入口 Worker。辅助 Worker 不使用此环境变量。如果对辅助 Worker 使用配置文件，请显式设置 configPath。

• configPath stringoptional

  Worker 配置文件的路径。 除非提供 config，否则此字段为必填项。

  有关 Worker 配置的更多信息，请参阅配置。

• config WorkerConfigCustomizer<false>optional

  以编程方式自定义或覆盖 Worker 配置。 在没有 configPath 的情况下使用时，允许完全在代码中定义辅助 Worker。

  使用示例请参阅编程式配置。

• viteEnvironment { name?: string; childEnvironments?: string[] }optional

  可选的 Vite 环境选项。 默认情况下，环境名称是 Worker 名称，其中 - 字符替换为 _。 在此设置名称将覆盖此行为。

  childEnvironments 选项用于通过 @vitejs/plugin-rsc ↗ 及基于它构建的框架支持 React Server Components。 这允许在单个 Worker 内嵌入具有独立模块图的附加环境。

  更多信息请参阅 Vite 环境。