devgen

为什么选择 devgen？

快速开始

安装

# 安装 devgen（包含所有工具）
go install github.com/tlipoca9/devgen/cmd/devgen@latest

# 或单独安装
go install github.com/tlipoca9/devgen/cmd/enumgen@latest
go install github.com/tlipoca9/devgen/cmd/validategen@latest

使用

devgen ./...                    # 运行所有生成器
devgen --include-tests ./...    # 同时生成测试文件
devgen --dry-run ./...          # 验证注解（不写入文件）
enumgen ./...                   # 仅运行枚举生成器
validategen ./...               # 仅运行验证生成器

核心特性

block-beta
    columns 4
    
    devgen["devgen CLI"]:4
    space down1<["加载"]>(down):2 space
    enumgen validategen custom["自定义插件"]:2
    space down2<["实现"]>(down):2 space
    genkit["genkit 框架"]:4
    Tool ConfigurableTool ValidatableTool RuleTool
    space down3<["驱动"]>(down):2 space
    vscode["VSCode 扩展"]:2 ai["AI 助手"]:2
    highlight["语法高亮"] complete["智能补全"] rules["读取 Rules"] suggest["代码建议"]

🤖 AI 原生集成

devgen 是首个内置 AI Rules 系统的 Go 代码生成工具。通过 RuleTool 接口，你的代码生成器可以自动生成 AI 编程助手能理解的文档。

# 为 CodeBuddy/Cursor 生成 AI Rules
devgen rules --agent codebuddy -w

生成的 rules 文件让 AI 助手能够：

• 理解你的注解语法和参数
• 提供准确的代码补全建议
• 在你编写代码时给出正确的使用示例

支持的 AI 助手：CodeBuddy、Cursor、GitHub Copilot、Windsurf

🧩 插件系统

基于 genkit 框架的插件架构，让你轻松开发自定义代码生成器：

// 只需实现 Tool 接口
type MyGenerator struct{}

func (m *MyGenerator) Name() string { return "mygen" }

func (m *MyGenerator) Run(gen *genkit.Generator, log *genkit.Logger) error {
    for _, pkg := range gen.Packages {
        for _, typ := range pkg.Types {
            if genkit.HasAnnotation(typ.Doc, "mygen", "gen") {
                // 生成代码...
            }
        }
    }
    return nil
}

var Tool genkit.Tool = &MyGenerator{}

两种插件模式：

详见 插件开发文档

💡 智能 IDE 支持

VSCode 扩展提供完整的开发体验：

• 语法高亮 - 注解关键字、参数值醒目显示
• 智能补全 - 输入 @ 自动提示可用注解（基于 ConfigurableTool）
• 实时诊断 - 注解错误、参数校验即时反馈（基于 ValidatableTool）
• 插件感知 - 自动识别自定义插件的注解配置

在 VSCode 扩展商店搜索 devgen 或点击上方徽章安装。

⚡ 可扩展接口

插件通过实现不同接口获得对应能力：

示例 - 实现 ConfigurableTool：

func (m *MyGenerator) Config() genkit.ToolConfig {
    return genkit.ToolConfig{
        OutputSuffix: "_gen.go",
        Annotations: []genkit.AnnotationConfig{
            {Name: "gen", Type: "type", Doc: "Generate code"},
        },
    }
}

VSCode 扩展通过 devgen config --json 获取注解元数据，提供智能补全。

示例 - 实现 ValidatableTool：

func (m *MyGenerator) Validate(gen *genkit.Generator, log *genkit.Logger) []genkit.Diagnostic {
    var diags []genkit.Diagnostic
    for _, pkg := range gen.Packages {
        for _, typ := range pkg.Types {
            if err := validateAnnotation(typ); err != nil {
                diags = append(diags, genkit.Diagnostic{
                    Pos:      typ.Pos,
                    End:      typ.End,
                    Severity: genkit.SeverityError,
                    Message:  err.Error(),
                })
            }
        }
    }
    return diags
}

VSCode 扩展通过 devgen --dry-run --json 获取诊断信息，实时显示注解错误。

示例 - 实现 RuleTool：

func (m *MyGenerator) Rules() []genkit.Rule {
    return []genkit.Rule{
        {
            Name:        "mygen",
            Description: "MyGenerator 使用指南",
            Content:     "# MyGenerator\n\n使用 `@gen` 注解标记类型...",
        },
    }
}

通过 devgen rules --agent codebuddy -w 生成 AI Rules 文件，让 AI 助手理解你的注解语法。

VSCode 扩展激活时会自动检测 AI IDE（Cursor、Windsurf、CodeBuddy），并自动运行此命令生成规则文件。

内置工具

enumgen - 枚举生成器

为 Go 枚举类型生成序列化、反序列化和验证方法。

// Status 表示状态
// enumgen:@enum(string, json, sql)
type Status int

const (
    StatusPending Status = iota + 1
    StatusActive
    StatusCanceled
)

生成：String() MarshalJSON() UnmarshalJSON() Value() Scan() IsValid() 等方法

详见 enumgen 文档

validategen - 验证生成器

为 Go 结构体生成 Validate() 方法。

// User 用户模型
// validategen:@validate
type User struct {
    // validategen:@required
    // validategen:@email
    Email string

    // validategen:@gte(0) @lte(150)
    Age int
}

支持：@required @email @url @min @max @oneof @regex 等 20+ 验证规则

详见 validategen 文档

构建

make build    # 构建所有工具
make test     # 运行测试
make install  # 安装到 $GOPATH/bin
make vscode   # 构建 VSCode 扩展

更新日志

许可证

MIT