feat: 重构 pkg/ast/provider 模块,优化代码组织逻辑和功能实现
## 主要改进 ### 架构重构 - 将单体 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.
This commit is contained in:
@@ -1,26 +1,26 @@
|
||||
package cmd
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strings"
|
||||
"text/template"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strings"
|
||||
"text/template"
|
||||
|
||||
"github.com/iancoleman/strcase"
|
||||
"github.com/spf13/cobra"
|
||||
"go.ipao.vip/atomctl/v2/templates"
|
||||
"github.com/iancoleman/strcase"
|
||||
"github.com/spf13/cobra"
|
||||
"go.ipao.vip/atomctl/v2/templates"
|
||||
)
|
||||
|
||||
// CommandNewProvider 注册 new_provider 命令
|
||||
func CommandNewProvider(root *cobra.Command) {
|
||||
cmd := &cobra.Command{
|
||||
Use: "provider",
|
||||
Short: "创建新的 provider",
|
||||
Long: `在 providers/<name> 目录下渲染创建 Provider 模板。
|
||||
cmd := &cobra.Command{
|
||||
Use: "provider",
|
||||
Short: "创建新的 provider",
|
||||
Long: `在 providers/<name> 目录下渲染创建 Provider 模板。
|
||||
|
||||
行为:
|
||||
- 当 name 与内置预置目录同名时,渲染该目录;否则回退渲染 providers/default
|
||||
@@ -33,35 +33,35 @@ func CommandNewProvider(root *cobra.Command) {
|
||||
示例:
|
||||
atomctl new provider email
|
||||
atomctl new --dry-run --dir ./demo provider cache`,
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
RunE: commandNewProviderE,
|
||||
}
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
RunE: commandNewProviderE,
|
||||
}
|
||||
|
||||
root.AddCommand(cmd)
|
||||
}
|
||||
|
||||
func commandNewProviderE(cmd *cobra.Command, args []string) error {
|
||||
// no-arg: list available preset providers
|
||||
if len(args) == 0 {
|
||||
entries, err := templates.Providers.ReadDir("providers")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
var names []string
|
||||
for _, e := range entries {
|
||||
if e.IsDir() {
|
||||
names = append(names, e.Name())
|
||||
}
|
||||
}
|
||||
sort.Strings(names)
|
||||
fmt.Println("可用预置 providers:")
|
||||
for _, n := range names {
|
||||
fmt.Printf(" - %s\n", n)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
// no-arg: list available preset providers
|
||||
if len(args) == 0 {
|
||||
entries, err := templates.Providers.ReadDir("providers")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
var names []string
|
||||
for _, e := range entries {
|
||||
if e.IsDir() {
|
||||
names = append(names, e.Name())
|
||||
}
|
||||
}
|
||||
sort.Strings(names)
|
||||
fmt.Println("可用预置 providers:")
|
||||
for _, n := range names {
|
||||
fmt.Printf(" - %s\n", n)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
providerName := args[0]
|
||||
providerName := args[0]
|
||||
// shared flags
|
||||
dryRun, _ := cmd.Flags().GetBool("dry-run")
|
||||
baseDir, _ := cmd.Flags().GetString("dir")
|
||||
@@ -80,38 +80,38 @@ func commandNewProviderE(cmd *cobra.Command, args []string) error {
|
||||
}
|
||||
}
|
||||
|
||||
// choose template source: providers/<name> or providers/default
|
||||
srcDir := filepath.Join("providers", providerName)
|
||||
if _, err := templates.Providers.ReadDir(srcDir); err != nil {
|
||||
srcDir = filepath.Join("providers", "default")
|
||||
}
|
||||
// choose template source: providers/<name> or providers/default
|
||||
srcDir := filepath.Join("providers", providerName)
|
||||
if _, err := templates.Providers.ReadDir(srcDir); err != nil {
|
||||
srcDir = filepath.Join("providers", "default")
|
||||
}
|
||||
|
||||
err := fs.WalkDir(templates.Providers, srcDir, func(path string, d fs.DirEntry, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if d.IsDir() {
|
||||
return nil
|
||||
}
|
||||
err := fs.WalkDir(templates.Providers, srcDir, func(path string, d fs.DirEntry, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if d.IsDir() {
|
||||
return nil
|
||||
}
|
||||
|
||||
relPath, err := filepath.Rel(srcDir, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
relPath, err := filepath.Rel(srcDir, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
destPath := filepath.Join(targetPath, strings.TrimSuffix(relPath, ".tpl"))
|
||||
if dryRun {
|
||||
fmt.Printf("[dry-run] mkdir -p %s\n", filepath.Dir(destPath))
|
||||
} else {
|
||||
if err := os.MkdirAll(filepath.Dir(destPath), os.ModePerm); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
destPath := filepath.Join(targetPath, strings.TrimSuffix(relPath, ".tpl"))
|
||||
if dryRun {
|
||||
fmt.Printf("[dry-run] mkdir -p %s\n", filepath.Dir(destPath))
|
||||
} else {
|
||||
if err := os.MkdirAll(filepath.Dir(destPath), os.ModePerm); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
tmpl, err := template.ParseFS(templates.Providers, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
tmpl, err := template.ParseFS(templates.Providers, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if dryRun {
|
||||
fmt.Printf("[dry-run] render > %s\n", destPath)
|
||||
|
||||
Reference in New Issue
Block a user