@cloudflare/codemods

Cloudflare开发项目升级的代码.

运行一个代号名称 :

npx @cloudflare/codemods vitest:v3-to-v4

可用的编码模式 :

• wrangler-to-cf - 将Wrangler配置迁移到新的 cf 配置格式
• vitest:v3-to-v4 移徙 @cloudflare/vitest-pool-workers 配置从 Vitest v3 to v4 (英语)
• vitest:pool-workers-to-vitest-plugin — 重命名 @cloudflare/vitest-pool-workers 改为 @cloudflare/vitest-plugin 单曲

使用 --dry-run 在不写的情况下列出更改, --cwd <path> 改为目标 其它项目,或重复 --files <glob> 限制审议的文件. 当目标在Git工作树内时,工作树必须是干净的. 使用 --force 绕过此安全检查.

以默认 Vite 捆绑器来迁移 Wrangler 工程 :

npx @cloudflare/codemods wrangler-to-cf --cwd ./path/to/project

CLI 检测出单个根 wrangler.json, (中文(简体) ), wrangler.jsonc,或 wrangler.toml。通过 --config <path> 选择其它文件,或通过 --bundler wrangler 以保留 Wrangler 特定工具配置。 对于这个编码器, --files 过滤选中的 Wrangler 配置并跳过不匹配的迁移 .

程序用途

代码也可以由JavaScript或TypeScript运行:

import { runCodemod } from "@cloudflare/codemods";

const { changedFiles } = await runCodemod("vitest:v3-to-v4", {
    cwd: process.cwd(),
    dryRun: false,
});

runCodemod 接受与CLI相同的编码名和别名. 其上下文也接受可选 files 财务报告和审定财务报表 force 字段对应 CLI 旗帜,并设置 dryRun 列表已更改文件而不写入。 它返回一个 CodemodResult 包含 changedFiles 如果代码无法运行,则拒绝。 CLI的清洁工作树检查也适用于方案运行.

移动朗格勒配置以查找

将 Wrangler 配置文件传递给 migrateWranglerToCf数字 :

import { migrateWranglerToCf } from "@cloudflare/codemods";

const result = await migrateWranglerToCf("./wrangler.jsonc", {
    bundler: "vite",
});

选项对象及其所有字段都是可选的. 默认为 Vite 捆绑器, 写入启用, 肮脏的工作树保护启用, 自动依赖安装启用 。 迁移安装 cf 缺少时, 安装 @cloudflare/vite-plugin@beta 当Vite被选中而插件缺失或不兼容时,在生成出Wrangler工具时升级Wrangler需要更新版本. Vite 插件依赖性仍然设置到 beta dist 标记 package.json; 包管理器安装更新了工程的锁文件. 项目管理 Vite 插件描述符, 如 workspace: 财务报告和审定财务报表 catalog: 保存;不兼容或未经核实的版本需要手动更新。 设定 installDependencies 改为 false 以防止依赖性变化;然后将所需的依赖性作为阻断后续。 移徙总是造成 cloudflare.config.ts; 选择 Wrangler 捆绑器也创建 wrangler.config.ts 当 Wrangler 特定工具配置存在时。 现有目标文件从未被覆盖 。 检查 result.followUps 何时 result.status 实值 needs-intervention。 。 。 .