ljwx-children/.claude/skills/code-review/README.md

Code Review Skill

自动化代码审查工具，集成安全扫描、代码质量检查、类型检查和最佳实践验证。

功能

• 🔒 安全审查 - 使用 Bandit 扫描安全漏洞
• ✨ 质量检查 - 使用 Flake8 检查代码质量
• 🎯 类型检查 - 使用 MyPy 进行类型检查
• 💡 最佳实践 - 检查常见的代码异味和反模式
• 📊 详细报告 - 按严重程度分类的问题报告

安装

必需依赖

# Git (通常已安装)
git --version

# Python 3.8+
python3 --version

可选依赖（推荐安装）

# 安装代码质量工具
pip install bandit flake8 mypy

# 验证安装
bandit --version
flake8 --version
mypy --version

使用方法

基本使用

# 审查所有变更的文件
python3 .claude/skills/code-review/review.py

# 审查特定目录
python3 .claude/skills/code-review/review.py --target src/api/

# 审查特定文件
python3 .claude/skills/code-review/review.py --target src/main.py

指定审查类型

# 只进行安全审查
python3 .claude/skills/code-review/review.py --type security

# 只进行质量审查
python3 .claude/skills/code-review/review.py --type quality

# 只进行类型检查
python3 .claude/skills/code-review/review.py --type performance

# 完整审查（默认）
python3 .claude/skills/code-review/review.py --type all

保存报告

# 保存审查报告到文件
python3 .claude/skills/code-review/review.py --output review-report.txt

# 完整命令示例
python3 .claude/skills/code-review/review.py \
  --target src/ \
  --type all \
  --output docs/reports/code-review-$(date +%Y%m%d).txt

与 Claude Code 集成

方式 1: 直接调用

# 在 Claude Code 中
"请运行代码审查"
# Claude 会调用这个 skill

方式 2: Git Hook

在 .git/hooks/pre-commit 中添加：

#!/bin/bash
python3 .claude/skills/code-review/review.py --type all
if [ $? -ne 0 ]; then
    echo "❌ Code review found critical issues. Fix them before committing."
    exit 1
fi

方式 3: GitHub Actions

# .github/workflows/code-review.yml
name: Code Review

on: [pull_request]

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'
      
      - name: Install tools
        run: pip install bandit flake8 mypy
      
      - name: Run code review
        run: |
          python3 .claude/skills/code-review/review.py \
            --output review-report.txt
      
      - name: Upload report
        uses: actions/upload-artifact@v3
        with:
          name: code-review-report
          path: review-report.txt

输出示例

🔍 Starting code review...

📁 Reviewing 5 files

🔒 Running security review...
✨ Running quality review...
🚀 Running type checking...
💡 Checking best practices...

================================================================================
📋 CODE REVIEW REPORT
================================================================================

Files Reviewed: 5
Total Issues: 12

🔴 CRITICAL (2 issues)
────────────────────────────────────────────────────────────────────────────────

  src/api/auth.py:45:12
  [security] Use of insecure MD5 hash function
  Code: B303

  src/database.py:78:8
  [security] SQL string formatting detected, possible SQL injection
  Code: B608

🟡 MEDIUM (5 issues)
────────────────────────────────────────────────────────────────────────────────

  src/models.py:23:1
  [quality] line too long (95 > 88 characters)
  Code: E501

  src/utils.py:56:0
  [best-practice] Avoid bare except clauses. Specify exception type.

🟢 LOW (5 issues)
────────────────────────────────────────────────────────────────────────────────

  src/main.py:12:0
  [best-practice] Use logging instead of print() for production code

  src/config.py:8:0
  [note] TODO found: # TODO: Add validation

================================================================================
⚠️  Action required: 2 critical issues must be fixed
================================================================================

审查清单

参考 checklist.md 了解完整的代码审查标准。

主要检查项：

• ✅ 安全性（无硬编码凭证、输入验证、防止注入）
• ✅ 性能（算法效率、数据库查询优化）
• ✅ 代码质量（DRY、SOLID、命名规范）
• ✅ 测试（单元测试、覆盖率）
• ✅ 文档（函数文档、API 文档）
• ✅ 最佳实践（日志、错误处理）

配置

自定义忽略模式

编辑 skill.json 中的 ignore_patterns：

{
  "configuration": {
    "ignore_patterns": [
      "*.pyc",
      "__pycache__",
      "node_modules",
      ".git",
      "*.min.js",
      "*.min.css",
      "tests/fixtures/*"
    ]
  }
}

调整严重程度阈值

{
  "configuration": {
    "severity_threshold": "medium"
  }
}

选项：low, medium, high, critical

故障排查

问题：工具未安装

# 检查工具是否安装
which bandit flake8 mypy

# 安装缺失的工具
pip install bandit flake8 mypy

问题：权限错误

# 确保脚本可执行
chmod +x .claude/skills/code-review/review.py

问题：没有发现问题但应该有

# 检查目标路径
ls -la src/

# 查看 git 变更
git status
git diff --name-only

扩展

添加新的检查

1. 在 review.py 中添加新方法：

def review_complexity(self, files: List[Path]) -> List[Dict]:
    """Check code complexity"""
    issues = []
    # 你的检查逻辑
    return issues

2. 在 run_review() 中调用：

if self.review_type in ['complexity', 'all']:
    all_issues.extend(self.review_complexity(files))

支持新语言

添加语言特定的审查逻辑：

def review_javascript(self, files: List[Path]) -> List[Dict]:
    """Review JavaScript files using ESLint"""
    # ESLint 集成
    pass

最佳实践

1. 在提交前运行 - 集成到 pre-commit hook
2. 定期运行 - 每天/每周对整个代码库运行
3. CI/CD 集成 - 在 PR 时自动运行
4. 逐步修复 - 从 critical/high 开始修复
5. 持续改进 - 根据团队需求调整规则

参考资源

• Bandit: https://bandit.readthedocs.io/
• Flake8: https://flake8.pycqa.org/
• MyPy: https://mypy.readthedocs.io/
• OWASP Top 10: https://owasp.org/www-project-top-ten/
• Clean Code: Robert C. Martin

---

版本: 1.0.0 创建时间: 2024-12-30 维护者: DevOps Team