protobuild

protobuild

面向 protobuf 工程的构建与管理工具：依赖同步、代码生成、检查、格式化与可视化配置。

文档总览

请先阅读总览文档：docs/INDEX.md

flowchart LR
  R[README] --> I[文档总览]
  I --> D[架构设计]
  I --> M[多源依赖]
  I --> E[配置示例]
  I --> A[评估审计]
  I --> S[智能体技能]

核心能力

• 统一构建：一条命令编译全部 proto
• 多源依赖：gomod、git、http、s3、gcs、local
• 配置驱动：基于 protobuf.yaml
• 代码检查：内置规则检查
• 格式化：支持 buf、内置格式化器与 clang-format
• 诊断与初始化：doctor、init
• 可视化管理：web 命令

典型工作流

flowchart TD
  A[初始化配置] --> B[同步依赖]
  B --> C[安装插件]
  C --> D[生成代码]
  D --> E[代码检查]
  E --> F[格式化]
  F --> G[发布或提交]

命令状态图

stateDiagram-v2
  [*] --> 未初始化
  未初始化 --> 已初始化: protobuild init
  已初始化 --> 依赖已同步: protobuild vendor
  依赖已同步 --> 代码已生成: protobuild gen
  代码已生成 --> 已检查: protobuild lint
  已检查 --> 已格式化: protobuild format -w
  已格式化 --> 可提交
  可提交 --> [*]

安装

go install github.com/pubgo/protobuild@latest

快速开始

1. 创建配置文件 protobuf.yaml
2. 执行 protobuild vendor
3. 执行 protobuild gen

示例配置：

vendor: .proto
root:
  - proto
includes:
  - proto
deps:
  - name: google/protobuf
    url: github.com/protocolbuffers/protobuf
    path: src/google/protobuf
plugins:
  - name: go
    out: pkg
    opt:
      - paths=source_relative

常用命令

目录级配置覆盖

在子目录放置 protobuf.plugin.yaml 可覆盖根配置：

plugins:
  - name: go
    out: pkg/api
    opt:
      - paths=source_relative

项目结构图

flowchart TD
  ROOT[protobuild]
  ROOT --> CMD[cmd]
  ROOT --> INTERNAL[internal]
  ROOT --> DOCS[docs]

  CMD --> P1[protobuild]
  CMD --> P2[formatcmd]
  CMD --> P3[linters]
  CMD --> P4[webcmd]

  INTERNAL --> I1[config]
  INTERNAL --> I2[depresolver]
  INTERNAL --> I3[modutil]
  INTERNAL --> I4[protoutil]
  INTERNAL --> I5[shutil]
  INTERNAL --> I6[typex]

  DOCS --> D1[INDEX]
  DOCS --> D2[DESIGN]
  DOCS --> D3[MULTI_SOURCE_DEPS]
  DOCS --> D4[EXAMPLES]
  DOCS --> D5[AUDIT_REVIEW]
  DOCS --> D6[AGENT_SKILL]

关联阅读

• 文档总览
• 架构设计
• 多源依赖设计
• 配置示例
• 评估审计
• 智能体技能指南