## 主要改进 ### 架构重构 - 将单体 provider.go 拆分为多个专门的模块文件 - 实现了清晰的职责分离和模块化设计 - 遵循 SOLID 原则,提高代码可维护性 ### 新增功能 - **验证规则系统**: 实现了完整的 provider 验证框架 - **报告生成器**: 支持多种格式的验证报告 (JSON/HTML/Markdown/Text) - **解析器优化**: 重新设计了解析流程,提高性能和可扩展性 - **错误处理**: 增强了错误处理和诊断能力 ### 修复关键 Bug - 修复 @provider(job) 注解缺失 __job 注入参数的问题 - 统一了 job 和 cronjob 模式的处理逻辑 - 确保了 provider 生成的正确性和一致性 ### 代码质量提升 - 添加了完整的测试套件 - 引入了 golangci-lint 代码质量检查 - 优化了代码格式和结构 - 增加了详细的文档和规范 ### 文件结构优化 ``` pkg/ast/provider/ ├── types.go # 类型定义 ├── parser.go # 解析器实现 ├── validator.go # 验证规则 ├── report_generator.go # 报告生成 ├── renderer.go # 渲染器 ├── comment_parser.go # 注解解析 ├── modes.go # 模式定义 ├── errors.go # 错误处理 └── validator_test.go # 测试文件 ``` ### 兼容性 - 保持向后兼容性 - 支持现有的所有 provider 模式 - 优化了 API 设计和用户体验 This completes the implementation of T025-T029 tasks following TDD principles, including validation rules implementation and critical bug fixes.
82 lines
2.1 KiB
Go
82 lines
2.1 KiB
Go
package cmd
|
||
|
||
import (
|
||
"os"
|
||
"path/filepath"
|
||
|
||
"github.com/rogeecn/swag"
|
||
"github.com/rogeecn/swag/gen"
|
||
log "github.com/sirupsen/logrus"
|
||
"github.com/spf13/cobra"
|
||
)
|
||
|
||
func CommandSwagInit(root *cobra.Command) {
|
||
cmd := &cobra.Command{
|
||
Use: "init",
|
||
Short: "swag init",
|
||
Aliases: []string{"i"},
|
||
Long: `生成 Swagger 文档(go/json/yaml)。
|
||
|
||
参数:
|
||
- --dir 项目根目录(默认 .)
|
||
- --out 输出目录(默认 docs)
|
||
- --main 主入口文件(默认 main.go)
|
||
|
||
说明:基于 rogeecn/swag 的 gen 构建器,支持模板分隔符定制、依赖解析等配置。`,
|
||
RunE: commandSwagInitE,
|
||
}
|
||
|
||
cmd.Flags().String("dir", ".", "SearchDir (project root)")
|
||
cmd.Flags().String("out", "docs", "Output dir for generated docs")
|
||
cmd.Flags().String("main", "main.go", "Main API file path")
|
||
|
||
root.AddCommand(cmd)
|
||
}
|
||
|
||
func commandSwagInitE(cmd *cobra.Command, args []string) error {
|
||
root := cmd.Flag("dir").Value.String()
|
||
if root == "" {
|
||
var err error
|
||
root, err = os.Getwd()
|
||
if err != nil {
|
||
return err
|
||
}
|
||
}
|
||
|
||
leftDelim, rightDelim := "{{", "}}"
|
||
|
||
outDir := cmd.Flag("out").Value.String()
|
||
mainFile := cmd.Flag("main").Value.String()
|
||
|
||
return gen.New().Build(&gen.Config{
|
||
SearchDir: root,
|
||
Excludes: "",
|
||
ParseExtension: "",
|
||
MainAPIFile: mainFile,
|
||
PropNamingStrategy: swag.CamelCase,
|
||
OutputDir: filepath.Join(root, outDir),
|
||
OutputTypes: []string{"go", "json", "yaml"},
|
||
ParseVendor: false,
|
||
ParseDependency: 0,
|
||
MarkdownFilesDir: "",
|
||
ParseInternal: false,
|
||
Strict: false,
|
||
GeneratedTime: false,
|
||
RequiredByDefault: false,
|
||
CodeExampleFilesDir: "",
|
||
ParseDepth: 100,
|
||
InstanceName: "",
|
||
OverridesFile: ".swaggo",
|
||
ParseGoList: true,
|
||
Tags: "",
|
||
LeftTemplateDelim: leftDelim,
|
||
RightTemplateDelim: rightDelim,
|
||
PackageName: "",
|
||
Debugger: log.WithField("module", "swag.init"),
|
||
CollectionFormat: "csv",
|
||
PackagePrefix: "",
|
||
State: "",
|
||
ParseFuncBody: false,
|
||
})
|
||
}
|