SuperAPI AI 工具集

proto-codegen

编程与开发

查看项目

更新于 10-16 06:42

技能介绍

用途:已发布的 @temporalio/proto 常落后于开发所用的 protos,此工具从当前 temporalio/api protos 重新生成一份可直接替换的 @temporalio/proto,让 UI 能在本地针对未发布字段构建和预览。

主要能力:从 temporalio/api 的 main、指定 tag、分支或 commit SHA 生成类型;可同时同步 ui-server 的 go.mod 并重建;可一键还原。

使用方式:

pnpm generate:proto --help

pnpm generate:proto pnpm generate:proto --ref v1.63.3 pnpm generate:proto --sync-ui-server pnpm generate:proto --sync-ui-server --ui-server-version v1.63.3 pnpm generate:proto --reset

常规运行会生成 vendor/temporalio-proto/,向 package.json 注入 @temporalio/proto override(本地未提交改动),并执行 pnpm install。完成后用 --reset 恢复干净状态。

两部分同步:字段名与值只有在 UI 的 TS 类型和 ui-server(server/go.mod)处于同一 proto 修订时才对齐,因为 gRPC 按字段号匹配,不一致会静默丢值或改名。--sync-ui-server 会先生成类型,再在 server/ 执行 go get go.temporal.io/api@<version> 与 make build,之后重启 pnpm dev:local-temporal。

版本轴注意:TS 类型来自 temporalio/api 的 git ref,而 ui-server 固定 go.temporal.io/api 的发布 tag,二者无精确一一对应,--sync-ui-server 默认用 @latest。

消费生成类型:import type { temporal, google } from '@temporalio/proto'; 仅生成 temporal.* 与 google.*。枚举字段可用 keyof typeof import('@temporalio/proto').temporal.api.enums.v1.ActivityExecutionStatus 派生字符串联合。

限制:这是本地开发解锁手段,不是随包发布的依赖;生成输出、override 与 go.mod 改动均为本地,不提交。依赖未发布 proto 的功能不得合并到 main,需等字段在已发布版本中提供后再用 --reset 删除本地设置。仅工具链被提交:scripts/generate-temporal-proto.ts、本技能、.gitignore 条目与 protobufjs-cli devDep;vendor/temporalio-proto/ 被 gitignore。