Proto Codegen

简体中文

English

简体中文

English

Appearance

CLI 命令 ​

generate ​

从 proto 文件生成 TypeScript 代码，是默认命令。

bash
proto-codegen generate [options]

选项：

  • -c, --config <file> - 配置文件路径（默认：proto-codegen.config.json）
  • --proto-dir <dir> - proto 文件目录
  • -o, --output-dir <dir> - 输出目录
  • --types-only - 仅生成类型定义
  • --clients-only - 仅生成 HTTP 客户端
  • --no-clean - 生成前不清空输出目录
  • --verbose - 启用详细日志
  • --log-level <level> - 日志级别（debug、info、warn、error）
bash
# 使用默认配置
proto-codegen generate

# 指定配置文件
proto-codegen generate -c my-config.json

# 仅生成类型
proto-codegen generate --types-only

# 设置输出目录
proto-codegen generate -o ./src/generated

publish ​

生成代码并发布到 npm 仓库。

bash
proto-codegen publish [options]

选项：

  • -c, --config <file> - 配置文件路径
  • --bump <type> - 版本升级类型（major、minor、patch），默认：patch
  • --version <version> - 指定版本号（覆盖自动升级）
  • --beta - 以 beta 版本发布
  • --tag <tag> - NPM dist-tag，默认：beta
  • --dry-run - 模拟执行，不实际发布
  • --module <name> - 仅发布指定模块
bash
# 发布稳定版本（自动 patch 升级）
proto-codegen publish

# 发布 beta 版本
proto-codegen publish --beta

# 指定版本
proto-codegen publish --version 2.0.0

# 模拟执行
proto-codegen publish --dry-run

生成代码并为前端开发创建本地链接。

bash
proto-codegen link [options]

选项：

  • -c, --config <file> - 配置文件路径
  • --module <name> - 仅链接指定模块
  • --target <dir> - 前端项目目录（自动更新 package.json）
  • --watch - 监听 proto 文件变更并重新链接
  • --dry-run - 模拟执行，不实际链接
bash
# 创建全局链接
proto-codegen link

# 链接到指定前端项目
proto-codegen link --target ./frontend

# 监听模式
proto-codegen link --watch

# 仅链接指定模块
proto-codegen link --module user-service

移除由 link 命令创建的链接。

bash
proto-codegen unlink [options]

选项：

  • -c, --config <file> - 配置文件路径
  • --module <name> - 仅取消链接指定模块
  • --target <dir> - 前端项目目录
  • --dry-run - 模拟执行，不实际取消链接