mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-13 02:41:50 +08:00
feat: Add orchestrator and state management for code review process
- Implemented orchestrator logic to manage code review phases, including state reading, action selection, and execution loop. - Defined state schema for review process, including metadata, context, findings, and execution tracking. - Created action catalog detailing actions for context collection, quick scan, deep review, report generation, and completion. - Established error recovery strategies and termination conditions for robust review handling. - Developed issue classification and quality standards documentation to guide review severity and categorization. - Introduced review dimensions with detailed checklists for correctness, security, performance, readability, testing, and architecture. - Added templates for issue reporting and review reports to standardize output and improve clarity.
This commit is contained in:
catlog22
186
.claude/skills/review-code/templates/issue-template.md
Normal file
186
.claude/skills/review-code/templates/issue-template.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# Issue Template
|
||||
|
||||
问题记录模板。
|
||||
|
||||
## Single Issue Template
|
||||
|
||||
```markdown
|
||||
#### {{severity_emoji}} [{{id}}] {{category}}
|
||||
|
||||
- **严重程度**: {{severity}}
|
||||
- **维度**: {{dimension}}
|
||||
- **文件**: `{{file}}`{{#if line}}:{{line}}{{/if}}
|
||||
- **描述**: {{description}}
|
||||
|
||||
{{#if code_snippet}}
|
||||
**问题代码**:
|
||||
```{{language}}
|
||||
{{code_snippet}}
|
||||
```
|
||||
{{/if}}
|
||||
|
||||
**建议**: {{recommendation}}
|
||||
|
||||
{{#if fix_example}}
|
||||
**修复示例**:
|
||||
```{{language}}
|
||||
{{fix_example}}
|
||||
```
|
||||
{{/if}}
|
||||
|
||||
{{#if references}}
|
||||
**参考资料**:
|
||||
{{#each references}}
|
||||
- {{this}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
```
|
||||
|
||||
## Issue Object Schema
|
||||
|
||||
```typescript
|
||||
interface Issue {
|
||||
id: string; // e.g., "SEC-001"
|
||||
severity: 'critical' | 'high' | 'medium' | 'low' | 'info';
|
||||
dimension: string; // e.g., "security"
|
||||
category: string; // e.g., "xss-risk"
|
||||
file: string; // e.g., "src/utils/render.ts"
|
||||
line?: number; // e.g., 42
|
||||
column?: number; // e.g., 15
|
||||
code_snippet?: string;
|
||||
description: string;
|
||||
recommendation: string;
|
||||
fix_example?: string;
|
||||
references?: string[];
|
||||
}
|
||||
```
|
||||
|
||||
## ID Generation
|
||||
|
||||
```javascript
|
||||
function generateIssueId(dimension, counter) {
|
||||
const prefixes = {
|
||||
correctness: 'CORR',
|
||||
readability: 'READ',
|
||||
performance: 'PERF',
|
||||
security: 'SEC',
|
||||
testing: 'TEST',
|
||||
architecture: 'ARCH'
|
||||
};
|
||||
|
||||
const prefix = prefixes[dimension] || 'MISC';
|
||||
const number = String(counter).padStart(3, '0');
|
||||
|
||||
return `${prefix}-${number}`;
|
||||
}
|
||||
```
|
||||
|
||||
## Severity Emojis
|
||||
|
||||
```javascript
|
||||
const SEVERITY_EMOJI = {
|
||||
critical: '🔴',
|
||||
high: '🟠',
|
||||
medium: '🟡',
|
||||
low: '🔵',
|
||||
info: '⚪'
|
||||
};
|
||||
```
|
||||
|
||||
## Issue Categories by Dimension
|
||||
|
||||
### Correctness
|
||||
- `null-check` - 缺少空值检查
|
||||
- `boundary` - 边界条件未处理
|
||||
- `error-handling` - 错误处理不当
|
||||
- `type-safety` - 类型安全问题
|
||||
- `logic-error` - 逻辑错误
|
||||
- `resource-leak` - 资源泄漏
|
||||
|
||||
### Security
|
||||
- `injection` - 注入风险
|
||||
- `xss` - 跨站脚本
|
||||
- `hardcoded-secret` - 硬编码密钥
|
||||
- `auth` - 认证授权
|
||||
- `sensitive-data` - 敏感数据
|
||||
|
||||
### Performance
|
||||
- `complexity` - 复杂度问题
|
||||
- `n+1-query` - N+1 查询
|
||||
- `memory-leak` - 内存泄漏
|
||||
- `blocking-io` - 阻塞 I/O
|
||||
- `inefficient-algorithm` - 低效算法
|
||||
|
||||
### Readability
|
||||
- `naming` - 命名问题
|
||||
- `function-length` - 函数过长
|
||||
- `nesting-depth` - 嵌套过深
|
||||
- `comments` - 注释问题
|
||||
- `duplication` - 代码重复
|
||||
|
||||
### Testing
|
||||
- `coverage` - 覆盖不足
|
||||
- `boundary-test` - 缺少边界测试
|
||||
- `test-isolation` - 测试不独立
|
||||
- `flaky-test` - 不稳定测试
|
||||
|
||||
### Architecture
|
||||
- `layer-violation` - 层次违规
|
||||
- `circular-dependency` - 循环依赖
|
||||
- `coupling` - 耦合过紧
|
||||
- `srp-violation` - 单一职责违规
|
||||
|
||||
## Example Issues
|
||||
|
||||
### Critical Security Issue
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "SEC-001",
|
||||
"severity": "critical",
|
||||
"dimension": "security",
|
||||
"category": "xss",
|
||||
"file": "src/components/Comment.tsx",
|
||||
"line": 25,
|
||||
"code_snippet": "element.innerHTML = userComment;",
|
||||
"description": "直接使用 innerHTML 插入用户输入，存在 XSS 攻击风险",
|
||||
"recommendation": "使用 textContent 或对用户输入进行 HTML 转义",
|
||||
"fix_example": "element.textContent = userComment;\n// 或\nelement.innerHTML = DOMPurify.sanitize(userComment);",
|
||||
"references": [
|
||||
"https://owasp.org/www-community/xss-filter-evasion-cheatsheet"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### High Correctness Issue
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "CORR-003",
|
||||
"severity": "high",
|
||||
"dimension": "correctness",
|
||||
"category": "error-handling",
|
||||
"file": "src/services/api.ts",
|
||||
"line": 42,
|
||||
"code_snippet": "try {\n await fetchData();\n} catch (e) {}",
|
||||
"description": "空的 catch 块会静默吞掉错误，导致问题难以发现和调试",
|
||||
"recommendation": "记录错误日志或重新抛出异常",
|
||||
"fix_example": "try {\n await fetchData();\n} catch (e) {\n console.error('Failed to fetch data:', e);\n throw e;\n}"
|
||||
}
|
||||
```
|
||||
|
||||
### Medium Readability Issue
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "READ-007",
|
||||
"severity": "medium",
|
||||
"dimension": "readability",
|
||||
"category": "function-length",
|
||||
"file": "src/utils/processor.ts",
|
||||
"line": 15,
|
||||
"description": "函数 processData 有 150 行，超过推荐的 50 行限制，难以理解和维护",
|
||||
"recommendation": "将函数拆分为多个小函数，每个函数负责单一职责",
|
||||
"fix_example": "// 拆分为:\nfunction validateInput(data) { ... }\nfunction transformData(data) { ... }\nfunction saveData(data) { ... }"
|
||||
}
|
||||
```
|
||||
173
.claude/skills/review-code/templates/review-report.md
Normal file
173
.claude/skills/review-code/templates/review-report.md
Normal file
@@ -0,0 +1,173 @@
|
||||
# Review Report Template
|
||||
|
||||
审查报告模板。
|
||||
|
||||
## Template Structure
|
||||
|
||||
```markdown
|
||||
# Code Review Report
|
||||
|
||||
## 审查概览
|
||||
|
||||
| 项目 | 值 |
|
||||
|------|------|
|
||||
| 目标路径 | `{{target_path}}` |
|
||||
| 文件数量 | {{file_count}} |
|
||||
| 代码行数 | {{total_lines}} |
|
||||
| 主要语言 | {{language}} |
|
||||
| 框架 | {{framework}} |
|
||||
| 审查时间 | {{review_duration}} |
|
||||
|
||||
## 问题统计
|
||||
|
||||
| 严重程度 | 数量 |
|
||||
|----------|------|
|
||||
| 🔴 Critical | {{critical_count}} |
|
||||
| 🟠 High | {{high_count}} |
|
||||
| 🟡 Medium | {{medium_count}} |
|
||||
| 🔵 Low | {{low_count}} |
|
||||
| ⚪ Info | {{info_count}} |
|
||||
| **总计** | **{{total_issues}}** |
|
||||
|
||||
### 按维度统计
|
||||
|
||||
| 维度 | 问题数 |
|
||||
|------|--------|
|
||||
| Correctness (正确性) | {{correctness_count}} |
|
||||
| Security (安全性) | {{security_count}} |
|
||||
| Performance (性能) | {{performance_count}} |
|
||||
| Readability (可读性) | {{readability_count}} |
|
||||
| Testing (测试) | {{testing_count}} |
|
||||
| Architecture (架构) | {{architecture_count}} |
|
||||
|
||||
---
|
||||
|
||||
## 高风险区域
|
||||
|
||||
{{#if risk_areas}}
|
||||
| 文件 | 原因 | 优先级 |
|
||||
|------|------|--------|
|
||||
{{#each risk_areas}}
|
||||
| `{{this.file}}` | {{this.reason}} | {{this.priority}} |
|
||||
{{/each}}
|
||||
{{else}}
|
||||
未发现明显的高风险区域。
|
||||
{{/if}}
|
||||
|
||||
---
|
||||
|
||||
## 问题详情
|
||||
|
||||
{{#each dimensions}}
|
||||
### {{this.name}}
|
||||
|
||||
{{#each this.findings}}
|
||||
#### {{severity_emoji this.severity}} [{{this.id}}] {{this.category}}
|
||||
|
||||
- **严重程度**: {{this.severity}}
|
||||
- **文件**: `{{this.file}}`{{#if this.line}}:{{this.line}}{{/if}}
|
||||
- **描述**: {{this.description}}
|
||||
|
||||
{{#if this.code_snippet}}
|
||||
```
|
||||
{{this.code_snippet}}
|
||||
```
|
||||
{{/if}}
|
||||
|
||||
**建议**: {{this.recommendation}}
|
||||
|
||||
{{#if this.fix_example}}
|
||||
**修复示例**:
|
||||
```
|
||||
{{this.fix_example}}
|
||||
```
|
||||
{{/if}}
|
||||
|
||||
---
|
||||
|
||||
{{/each}}
|
||||
{{/each}}
|
||||
|
||||
## 审查建议
|
||||
|
||||
### 必须修复 (Must Fix)
|
||||
|
||||
{{must_fix_summary}}
|
||||
|
||||
### 建议改进 (Should Fix)
|
||||
|
||||
{{should_fix_summary}}
|
||||
|
||||
### 可选优化 (Nice to Have)
|
||||
|
||||
{{nice_to_have_summary}}
|
||||
|
||||
---
|
||||
|
||||
*报告生成时间: {{generated_at}}*
|
||||
```
|
||||
|
||||
## Variable Definitions
|
||||
|
||||
| Variable | Type | Source |
|
||||
|----------|------|--------|
|
||||
| `{{target_path}}` | string | state.context.target_path |
|
||||
| `{{file_count}}` | number | state.context.file_count |
|
||||
| `{{total_lines}}` | number | state.context.total_lines |
|
||||
| `{{language}}` | string | state.context.language |
|
||||
| `{{framework}}` | string | state.context.framework |
|
||||
| `{{review_duration}}` | string | Formatted duration |
|
||||
| `{{critical_count}}` | number | Count of critical findings |
|
||||
| `{{high_count}}` | number | Count of high findings |
|
||||
| `{{medium_count}}` | number | Count of medium findings |
|
||||
| `{{low_count}}` | number | Count of low findings |
|
||||
| `{{info_count}}` | number | Count of info findings |
|
||||
| `{{total_issues}}` | number | Total findings |
|
||||
| `{{risk_areas}}` | array | state.scan_summary.risk_areas |
|
||||
| `{{dimensions}}` | array | Grouped findings by dimension |
|
||||
| `{{generated_at}}` | string | ISO timestamp |
|
||||
|
||||
## Helper Functions
|
||||
|
||||
```javascript
|
||||
function severity_emoji(severity) {
|
||||
const emojis = {
|
||||
critical: '🔴',
|
||||
high: '🟠',
|
||||
medium: '🟡',
|
||||
low: '🔵',
|
||||
info: '⚪'
|
||||
};
|
||||
return emojis[severity] || '⚪';
|
||||
}
|
||||
|
||||
function formatDuration(ms) {
|
||||
const minutes = Math.floor(ms / 60000);
|
||||
const seconds = Math.floor((ms % 60000) / 1000);
|
||||
return `${minutes}分${seconds}秒`;
|
||||
}
|
||||
|
||||
function generateMustFixSummary(findings) {
|
||||
const critical = findings.filter(f => f.severity === 'critical');
|
||||
const high = findings.filter(f => f.severity === 'high');
|
||||
|
||||
if (critical.length + high.length === 0) {
|
||||
return '未发现必须立即修复的问题。';
|
||||
}
|
||||
|
||||
return `发现 ${critical.length} 个严重问题和 ${high.length} 个高优先级问题，建议在合并前修复。`;
|
||||
}
|
||||
```
|
||||
|
||||
## Usage Example
|
||||
|
||||
```javascript
|
||||
const report = generateReport({
|
||||
context: state.context,
|
||||
summary: state.summary,
|
||||
findings: state.findings,
|
||||
scanSummary: state.scan_summary
|
||||
});
|
||||
|
||||
Write(`${workDir}/review-report.md`, report);
|
||||
```
|
||||
Reference in New Issue
Block a user