@dtt_siye/atool 1.1.0

package/skills/project-analyze/rules/go.md

@@ -0,0 +1,289 @@
+# Go 项目分析规则
+
+## 分析粒度
+
+按 Go package（目录）和分层架构（Handler → Service → Repository → Model）进行分析。
+
+```
+cmd/（入口）
+    ↓
+internal/
+    ├── handler/（HTTP 处理器）
+    ├── service/（业务逻辑）
+    ├── repository/（数据访问）
+    ├── model/（数据模型）
+    ├── middleware/（中间件）
+    └── config/（配置）
+    ↓
+pkg/（可导出公共包）
+    ↓
+api/（API 定义）
+```
+
+## 目录扫描策略
+
+### 1. 识别项目布局
+
+**信号文件检测：**
+- `go.mod` → Go Module
+- `go.sum` → 依赖锁定
+- `main.go` → 可执行程序
+- 按 golang-standards/project-layout 组织
+
+### 2. 识别项目类型
+
+- **Web API**: `gin`, `echo`, `fiber`, `chi` 依赖
+- **gRPC**: `google.golang.org/grpc`, `protobuf` 依赖
+- **CLI**: `cobra`, `urfave/cli` 依赖
+- **微服务**: `go-micro`, `kratos` 依赖
+
+### 3. 依赖提取
+
+从 `go.mod` 提取：
+
+| 类别 | 常见依赖 |
+|------|----------|
+| Web 框架 | gin, echo, fiber, chi |
+| gRPC | google.golang.org/grpc |
+| ORM | gorm, sqlx, ent |
+| 配置 | viper, envconfig |
+| 日志 | zap, logrus, zerolog |
+| 测试 | testify, mockgen |
+| 数据库驱动 | pgx, go-sql-driver/mysql |
+| 缓存 | go-redis |
+| 消息队列 | amqp, sarama |
+| DI | wire, fx |
+| 验证 | go-playground/validator |
+
+### 4. 按层扫描路径
+
+- **入口**: `cmd/` 下的 main.go
+- **Handler**: `internal/handler/`, `internal/http/`, `internal/controller/`
+- **Service**: `internal/service/`, `internal/usecase/`, `internal/biz/`
+- **Repository**: `internal/repository/`, `internal/store/`, `internal/data/`
+- **Model**: `internal/model/`, `internal/domain/`, `internal/entity/`
+- **Middleware**: `internal/middleware/`
+- **Config**: `internal/config/`, `config/`
+- **公共包**: `pkg/` 下的子目录
+- **API 定义**: `api/` (Protobuf / OpenAPI)
+
+## 各层提取规则
+
+### 层 1: Handler 层
+
+**扫描文件**: `internal/handler/*.go`, `internal/http/*.go`
+
+**提取内容**:
+- Handler 函数签名
+- 路由注册（路由路径 + HTTP 方法 + Handler 函数）
+- 请求/响应结构体
+- 使用的 Service
+- 中间件链
+
+**输出示例**:
+```
+### UserHandler
+- **路径**: `internal/handler/user_handler.go`
+- **依赖注入**: UserService (interface)
+- **Handler 方法**:
+  | 方法 | 签名 | 说明 |
+  |------|------|------|
+  | CreateUser | (c *gin.Context) | 创建用户 |
+  | GetUser | (c *gin.Context) | 获取用户详情 |
+  | ListUsers | (c *gin.Context) | 分页查询 |
+  | UpdateUser | (c *gin.Context) | 更新用户 |
+  | DeleteUser | (c *gin.Context) | 删除用户 |
+
+### 路由注册
+- **文件**: `internal/router/router.go`
+- **路由表**:
+  | 方法 | 路径 | Handler | 中间件 | 说明 |
+  |------|------|---------|--------|------|
+  | POST | /api/v1/users | CreateUser | Auth, Admin | 创建用户 |
+  | GET | /api/v1/users/:id | GetUser | Auth | 获取用户 |
+  | GET | /api/v1/users | ListUsers | Auth | 用户列表 |
+  | PUT | /api/v1/users/:id | UpdateUser | Auth, Admin | 更新用户 |
+  | DELETE | /api/v1/users/:id | DeleteUser | Auth, Admin | 删除用户 |
+```
+
+### 层 2: Service 层
+
+**扫描文件**: `internal/service/*.go`
+
+**提取内容**:
+- Service interface 定义
+- 方法签名（参数 + 返回值）
+- 实现类的业务逻辑摘要
+- 依赖的 Repository / 其他 Service
+
+**输出示例**:
+```
+### UserService interface
+- **路径**: `internal/service/user_service.go`
+- **方法**:
+  | 方法 | 签名 | 说明 |
+  |------|------|------|
+  | Create | (ctx, CreateUserReq) (*User, error) | 创建用户（校验+哈希密码+存储） |
+  | GetByID | (ctx, int64) (*User, error) | 按 ID 查询 |
+  | List | (ctx, ListUsersReq) ([]*User, int64, error) | 分页列表（返回总数） |
+  | Update | (ctx, int64, UpdateUserReq) (*User, error) | 更新用户 |
+  | Delete | (ctx, int64) error | 删除用户 |
+- **实现**: userServiceImpl
+- **依赖**: UserRepository, PasswordEncoder, CacheService
+```
+
+### 层 3: Repository 层
+
+**扫描文件**: `internal/repository/*.go`
+
+**提取内容**:
+- Repository interface 定义
+- 数据库操作方法（SQL / GORM / Ent）
+- 数据源类型
+
+**输出示例**:
+```
+### UserRepository interface
+- **路径**: `internal/repository/user_repository.go`
+- **数据源**: PostgreSQL (pgx)
+- **方法**:
+  | 方法 | 签名 | SQL/GORM | 说明 |
+  |------|------|---------|------|
+  | Create | (ctx, *User) error | INSERT INTO users (...) | 创建 |
+  | FindByID | (ctx, int64) (*User, error) | SELECT * FROM users WHERE id=$1 | 按 ID 查询 |
+  | FindByEmail | (ctx, string) (*User, error) | SELECT * FROM users WHERE email=$1 | 按邮箱查询 |
+  | Update | (ctx, *User) error | UPDATE users SET ... WHERE id=$1 | 更新 |
+  | Delete | (ctx, int64) error | DELETE FROM users WHERE id=$1 | 删除 |
+  | List | (ctx, offset, limit int) ([]*User, int64, error) | SELECT + COUNT | 分页列表 |
+```
+
+### 层 4: Model 层
+
+**扫描文件**: `internal/model/*.go`
+
+**提取内容**:
+- struct 定义（字段 + 类型 + tag）
+- GORM / Ent model 注解
+- 验证 tag（`binding`, `validate`）
+
+**输出示例**:
+```
+### User Model
+- **路径**: `internal/model/user.go`
+- **定义**:
+  ```go
+  type User struct {
+      ID        int64     `json:"id" gorm:"primaryKey;autoIncrement"`
+      Username  string    `json:"username" gorm:"uniqueIndex;size:50;not null" binding:"required,min=3,max=50"`
+      Email     string    `json:"email" gorm:"uniqueIndex;size:100;not null" binding:"required,email"`
+      Password  string    `json:"-" gorm:"size:255;not null" binding:"required,min=6"`
+      Role      string    `json:"role" gorm:"size:20;default:'user'" binding:"omitempty,oneof=admin user"`
+      CreatedAt time.Time `json:"created_at" gorm:"autoCreateTime"`
+      UpdatedAt time.Time `json:"updated_at" gorm:"autoUpdateTime"`
+  }
+  ```
+- **表名**: `users`
+- **索引**: username (unique), email (unique)
+```
+
+### 层 5: 中间件层
+
+**扫描文件**: `internal/middleware/*.go`
+
+**提取内容**:
+- 中间件函数签名
+- 处理链路
+- 应用位置
+
+**输出示例**:
+```
+### 中间件链
+| 顺序 | 中间件 | 用途 | 应用范围 |
+|------|--------|------|----------|
+| 1 | Logger | 请求日志（zap） | 全局 |
+| 2 | Recovery | Panic 恢复 | 全局 |
+| 3 | CORS | 跨域处理 | 全局 |
+| 4 | Auth | JWT Token 验证 | /api/* |
+| 5 | RBAC | 角色权限检查 | 管理接口 |
+```
+
+### 层 6: 并发模式分析
+
+**扫描文件**: 含 `goroutine`, `chan`, `select`, `sync` 的文件
+
+**提取内容**:
+- goroutine 使用场景
+- channel 类型和方向
+- sync 原语（Mutex, WaitGroup, Once）
+
+**输出示例**:
+```
+### 并发模式
+| 模式 | 位置 | 说明 |
+|------|------|------|
+| goroutine + channel | service/notification.go | 异步发送通知 |
+| sync.Mutex | cache/in_memory.go | 缓存读写锁 |
+| sync.WaitGroup | service/batch.go | 批量操作等待 |
+| errgroup | service/sync.go | 并发错误处理 |
+```
+
+## 输出模板
+
+### README.md 章节结构
+
+```markdown
+# {项目名}
+
+## 项目概述
+服务功能描述
+
+## 技术栈
+| 技术 | 版本 | 用途 |
+|------|------|------|
+
+## 架构设计
+### 架构图（ASCII）
+### 数据流图
+
+## 目录结构
+cmd/ internal/ pkg/ 说明
+
+## API 路由
+路由表 + 中间件链
+
+## 数据模型
+struct 定义 + 关系
+
+## 配置
+环境变量 + 配置文件
+
+## 构建 & 运行
+go build / go run / make
+```
+
+## 模块边界识别
+
+以下目录模式下的每个子目录视为独立模块（L2+ 分析时生成 MODULE-DOC.md）：
+
+| 层 | 扫描路径 | 模块判定规则 | MODULE-DOC slug 来源 |
+|----|----------|-------------|---------------------|
+| 命令入口层 | `cmd/{name}/` | 每个子目录 | 目录名 kebab-case |
+| 内部包层 | `internal/{name}/` | 每个子目录 | 目录名 kebab-case |
+| 公共包层 | `pkg/{name}/` | 每个子目录 | 目录名 kebab-case |
+| API 层 | `api/` | 每个文件 | 文件名去后缀 kebab-case |
+| 组件层 | 同 API/内部包层 | 3+ 文件的子目录 | 目录名 kebab-case |
+
+**不视为独立模块的情况**：
+- 单文件入口（如 `main.go`, `cmd/root.go`）
+- 纯导出桶文件（仅有 re-export）
+- 工具函数目录（`util/`, `helper/`）— 合并为一个模块
+- `vendor/` 跳过
+
+## Token 管理
+
+- 大包（>15 文件）拆分为子任务
+- 每个子任务分析 ≤10 文件
+- `go.mod` 依赖分析单独一个子任务
+- 生成文件（`*_gen.go`, `*.pb.go`）可跳过或简要分析
+- `vendor/` 目录跳过
+- `*_test.go` 文件单独分组分析

package/skills/project-analyze/rules/harmony.md

@@ -0,0 +1,257 @@
+# HarmonyOS / ArkTS 项目分析规则
+
+## 分析粒度
+
+按 Entry/Feature/Common 模块和 ArkUI 组件层次进行分析。
+
+```
+EntryAbility（应用入口）
+    ↓
+Pages（页面）
+    ↓
+@Components（自定义组件）
+    ↓
+@ViewModel / @Observed（状态管理）
+    ↓
+Service / Utils（服务/工具）
+    ↓
+Model（数据模型）
+    ↓
+Resources（资源文件）
+```
+
+## 目录扫描策略
+
+### 1. 识别项目结构
+
+**信号文件检测：**
+- `build-profile.json5` → 构建配置
+- `oh-package.json5` → 包管理
+- `AppScope/` → 应用级配置
+- `entry/` → 主模块
+- `feature/` → 功能模块
+- `common/` → 公共模块
+
+### 2. 依赖提取
+
+从 `oh-package.json5` 提取：
+
+| 类别 | 常见依赖 |
+|------|----------|
+| UI | @ohos.arkui.UIContext |
+| 网络 | @ohos.net.http |
+| 数据存储 | @ohos.data.preferences, @ohos.data.relationalStore |
+| 路由 | @ohos.router (router) |
+| 多媒体 | @ohos.multimedia.image |
+| 设备信息 | @ohos.device.info |
+
+### 3. 按层扫描路径
+
+- **Pages**: `*/pages/*.ets`
+- **Components**: `*/components/*.ets`
+- **ViewModel**: `*/viewmodel/*.ets`, `*/viewmodels/*.ets`
+- **Model**: `*/model/*.ets`, `*/models/*.ets`
+- **Service**: `*/service/*.ets`, `*/services/*.ets`
+- **Utils**: `*/utils/*.ets`, `*/common/*.ets`
+
+## 各层提取规则
+
+### 层 1: 模块结构分析
+
+**扫描文件**: `build-profile.json5`, `oh-package.json5`
+
+**提取内容**:
+- 模块列表（Entry/Feature/Common）
+- 模块间依赖关系
+- 每个模块的入口
+
+**输出示例**:
+```
+### 模块结构
+- **文件**: `build-profile.json5`
+- **模块列表**:
+  | 模块名 | 类型 | 职责 |
+  |--------|------|------|
+  | entry | Entry | 主入口，包含 UIAbility 和主页面 |
+  | feature-home | Feature | 首页模块 |
+  | feature-user | Feature | 用户管理模块 |
+  | feature-settings | Feature | 设置模块 |
+  | common-utils | Common | 公共工具 |
+  | common-network | Common | 网络请求封装 |
+- **模块依赖**:
+  entry → feature-home, feature-user, feature-settings
+  feature-user → common-network, common-utils
+```
+
+### 层 2: @Component 组件分析
+
+**扫描文件**: `*/pages/*.ets`, `*/components/*.ets`
+
+**提取内容**:
+- 组件名 + `@Component` 装饰器
+- `build()` 方法中的 UI 结构
+- 状态变量（`@State`, `@Prop`, `@Link`, `@Provide`, `@Consume`）
+- `@Watch` 回调
+- `@Builder` 方法
+
+**输出示例**:
+```
+### UserListPage
+- **路径**: `entry/src/main/ets/pages/UserListPage.ets`
+- **装饰器**: @Entry, @Component
+- **状态变量**:
+  | 变量 | 装饰器 | 类型 | 初始值 | 说明 |
+  |------|--------|------|--------|------|
+  | userList | @State | UserVO[] | [] | 用户列表 |
+  | isLoading | @State | boolean | false | 加载状态 |
+  | searchQuery | @State | string | '' | 搜索关键词 |
+  | userService | - | UserService | new UserService() | 服务实例 |
+- **@Watch**:
+  | 变量 | 回调 | 说明 |
+  |------|------|------|
+  | searchQuery | onSearchQueryChange | 防抖搜索 |
+- **@Builder**:
+  | 名称 | 说明 |
+  |------|------|
+  | UserItemBuilder | 用户列表项 |
+  | EmptyViewBuilder | 空状态视图 |
+- **UI 结构**:
+  Column() {
+    SearchBar({ placeholder: '搜索用户' })
+      .onChange((value) => this.searchQuery = value)
+    if (this.isLoading) { Progress() }
+    else if (this.userList.length === 0) { this.EmptyViewBuilder() }
+    else { List() { ForEach(this.userList, (item) => { this.UserItemBuilder(item) }) } }
+  }
+```
+
+### 层 3: ViewModel / 状态管理分析
+
+**扫描文件**: `*/viewmodel/*.ets`
+
+**输出示例**:
+```
+### UserViewModel
+- **路径**: `feature-user/src/main/ets/viewmodel/UserViewModel.ts`
+- **状态变量**:
+  | 变量 | 装饰器 | 类型 | 说明 |
+  |------|--------|------|------|
+  | users | @Provide | UserVO[] | 用户列表 |
+  | isLoading | @Provide | boolean | 加载状态 |
+  | currentPage | @State | number | 当前页码 |
+- **方法**:
+  | 方法 | 签名 | 说明 |
+  |------|------|------|
+  | loadUsers | async () => Promise<void> | 加载用户列表 |
+  | searchUsers | (query: string) => void | 搜索用户 |
+  | deleteUser | (id: number) => Promise<void> | 删除用户 |
+- **AppStorage**: 'userToken' (全局共享)
+```
+
+### 层 4: 资源文件分析
+
+**扫描文件**: `resources/base/element/*.json`
+
+**输出示例**:
+```
+### 字符串资源
+| Key | 中文 | 英文 |
+|-----|------|------|
+| app_name | 用户管理 | User Management |
+| login_button | 登录 | Login |
+| search_placeholder | 搜索 | Search |
+
+### 颜色资源
+| Key | 值 | 用途 |
+|-----|------|------|
+| primary_color | #007DFF | 主色调 |
+| text_primary | #182431 | 主文本色 |
+| background_color | #F1F3F5 | 背景色 |
+
+### 浮点数资源
+| Key | 值 | 用途 |
+|-----|------|------|
+| spacing_xs | 4vp | 极小间距 |
+| spacing_sm | 8vp | 小间距 |
+| spacing_md | 16vp | 中间距 |
+| spacing_lg | 24vp | 大间距 |
+```
+
+### 层 5: 网络请求分析
+
+**扫描文件**: `*/service/*Http*.ets`, `*/network/*.ets`
+
+**输出示例**:
+```
+### 网络配置
+- **文件**: `common-network/src/main/ets/utils/HttpUtil.ets`
+- **baseURL**: `https://api.example.com`
+- **超时**: 15000ms
+- **Header**: `Content-Type: application/json`, `Authorization: Bearer {token}`
+- **拦截器**:
+  | 拦截器 | 说明 |
+  |--------|------|
+  | AuthInterceptor | 注入 token |
+  | ErrorHandler | 统一错误处理 |
+```
+
+## 输出模板
+
+### README.md 章节结构
+
+```markdown
+# {应用名}
+
+## 项目概述
+应用功能描述
+
+## 技术栈
+| 技术 | 版本 | 用途 |
+|------|------|------|
+
+## 架构设计
+### 架构图（ASCII）
+### 模块依赖图
+
+## 模块说明
+Entry/Feature/Common 各模块职责
+
+## 页面结构
+页面列表 + 路由关系
+
+## 组件文档
+@Component 列表
+
+## 资源文件
+字符串/颜色/尺寸资源
+
+## 构建 & 部署
+DevEco Studio + hvigor 命令
+```
+
+## 模块边界识别
+
+以下目录模式下的每个子目录视为独立模块（L2+ 分析时生成 MODULE-DOC.md）：
+
+| 层 | 扫描路径 | 模块判定规则 | MODULE-DOC slug 来源 |
+|----|----------|-------------|---------------------|
+| 页面层 | `entry/src/main/ets/pages/` | 每个子目录或文件 | 名称 kebab-case |
+| 服务层 | `entry/src/main/ets/services/` | 每个子目录 | 目录名 kebab-case |
+| 状态管理层 | `AppStorage`, `LocalStorage` | 按业务域分组 | 业务域 kebab-case |
+| 组件层 | `entry/src/main/ets/components/` | 3+ 文件的子目录 | 目录名 kebab-case |
+| Feature 模块 | 每个 feature 目录 | 独立模块 | 目录名 kebab-case |
+
+**不视为独立模块的情况**：
+- 单文件入口（如 `EntryAbility.ts`, `Index.ets`）
+- 纯导出桶文件（仅有 re-export）
+- 工具函数目录（`utils/`, `common/`）— 合并为一个模块
+- `.preview/`, `oh_modules/` 跳过
+
+## Token 管理
+
+- 大模块（>15 文件）拆分为子任务
+- 每个子任务分析 ≤10 文件
+- 资源文件（JSON）单独分析
+- `build-profile.json5` 和 `oh-package.json5` 单独分析
+- `.preview/` 目录跳过
+- `oh_modules/` 目录跳过