Compétence : revue de code

Ce projet construit une compétence de revue de code. Une fois que les utilisateurs ont téléversé des fichiers de code, elle analyse automatiquement la qualité du code, les problèmes de style et les bogues potentiels.

Objectif : maîtriser l'intégration de la chaîne d'outils et la génération de rapports de problèmes structurés.


Analyse des exigences du projet

FonctionnalitésLangages pris en chargeOutils
Vérification de la syntaxePythonpy_compile (intégré)
Vérification du style de codePythonflake8
Analyse de complexité du codePythonradon
Vérification JavaScriptJS/TSeslint(n)
Problème completTousScript d'agrégation personnalisé

Structure du répertoire

code-reviewer/
├── SKILL.md
└── scripts/
    ├── requirements.txt
    ├── check_python.py
    ├── check_js.py
    └── generate_report.py

Script de code Python

Exemple

# Chemin du fichier : scripts/check_python.py
import subprocess
import sys
import json
import os

def ensure_tools():
    """S'assurer que la vérification est installée"""
    for pkg in ["flake8", "radon"]:
        try:
            __import__(pkg.replace("-", "_"))
        except ImportError:
            subprocess.run([sys.executable, "-m", "pip", "install", pkg,
                            "--break-system-packages", "--quiet"])

def check_syntax(file_path: str) -> dict:
    """Vérifier la syntaxe Python"""
    result = subprocess.run(
        [sys.executable, "-m", "py_compile", file_path],
        capture_output=True, text=True
    )
    if result.returncode == 0:
        return {"passed": True, "errors": []}
    return {
        "passed": False,
        "errors": [result.stderr.strip()]
    }

def check_style(file_path: str) -> list:
    """Exécuter flake8 pour vérifier le style de code, retourner une liste de problèmes"""
    result = subprocess.run(
        ["python", "-m", "flake8", file_path,
         "--max-line-length=100",
         "--format=%(row)d:%(col)d %(code)s %(text)s"],
        capture_output=True, text=True
    )
    tickets = []
    for line in result.stdout.strip().splitlines():
        parts = line.split(" ", 2)
        if len(parts) >= 3:
            loc, code, text = parts
            row, col = loc.split(":")
            issues.append({
                "line": int(row), "col": int(col),
                "code": code,     "message": text
            })
    return issues

def check_complexity(file_path: str) -> list:
    """Utiliser radon pour analyser la complexité des fonctions, renvoyer les fonctions à complexité élevée"""
    result = subprocess.run(
        ["python", "-m", "radon", "cc", file_path, "-s", "--json"],
        capture_output=True, text=True
    )
    try:
        data      = json.loads(result.stdout)
        functions = data.get(file_path, [])
        # Ne renvoyer que les fonctions dont le grade de complexité est C ou supérieur (complexité > 10)
        return [
            {"name": f["name"], "complexity": f["complexity"],
             "rank": f["rank"], "line": f["lineno"]}
            for f in functions
            if f.get("rank", "A") in ("C", "D", "E", "F")
        ]
    except Exception:
        return []

def review_python(file_path: str) -> dict:
    """Exécuter une revue complète du code Python"""
    if not os.path.exists(file_path):
        return {"status": "error", "message": f"Le fichier n'existe pas : {file_path}"}

    ensure_tools()

    syntax     = check_syntax(file_path)
    style      = check_style(file_path) if syntax["passed"] else []
    complexity = check_complexity(file_path) if syntax["passed"] else []

    # Calculer la note globale
    error_count   = len([i for i in style if i["code"].startswith("E")])
    warning_count = len([i for i in style if i["code"].startswith("W")])

    if not syntax["passed"]:
        grade = "F"
    elif error_count > 10:
        grade = "C"
    elif error_count > 3:
        grade = "B"
    else:
        grade = "A"

    return {
        "status":          "success",
        "file":            os.path.basename(file_path),
        "grade": grade,
        "syntax_ok": syntaxe["réussi"],
        "syntax_errors": syntaxe["erreurs"],
        "style_issues": style[:20],          # Afficher au plus 20 éléments
        "style_count":     len(style),
        "error_count": error_count,
        "warning_count": warning_count,
        "complex_functions": complexité
    }

if __name__ == "__main__":
    result = review_python(sys.argv[1] if len(sys.argv) > 1 else "")
    print(json.dumps(result, ensure_ascii=False, indent=2))

Sortie :

{
  "status": "success",
  "file": "example_app.py",
  "grade": "B",
  "syntax_ok": true,
  "style_issues": [
    {"line": 12, "col": 1, "code": "E302", "message": "expected 2 blank lines"},
    {"line": 34, "col": 80, "code": "E501", "message": "line too long (103 > 100)"}
  ],
  "style_count": 5,
  "error_count": 3,
  "warning_count": 2,
  "complex_functions": []
}

SKILL.md Contenu complet

---
name: code-reviewer
version: 1.0.0
description: >
  自动审查用户上传的代码文件,检查语法错误、风格问题和代码复杂度,
  生成带评级的问题报告并给出改进建议。当用户需要代码审查、
  检查代码质量、查找 Bug、评估代码规范时触发。
---

# 代码审查助手

## 执行流程

### 第一步:识别代码文件

获取用户上传的代码文件路径,识别编程语言(根据扩展名):
- .py → Python 审查
- .js / .ts → JavaScript/TypeScript 审查
- 其他格式 → 告知暂不支持,列出支持的格式

### 第二步:运行自动化检查

Python 文件运行:
```bash
cd scripts/
python check_python.py <文件路径>
```

### 第三步:生成并解读报告

根据 JSON 输出,以人性化方式呈现结果:

1. **总体评级**:A(优秀)/ B(良好)/ C(需改进)/ F(语法错误)
2. **问题汇总表格**:行号、问题代码、描述
3. **Top 3 优先修复项**:选出最严重的 3 个问题,给出修复建议和示例

若文件无问题,给出简短正面评价:
> 代码检查通过!共扫描 X 行,未发现语法错误和明显风格问题。

Cas de test

Exemple

# Chemin de fichier : scripts/tests/test_sample.py (fichier d'exemple utilisé pour tester la compétence de revue)
# Contient intentionnellement quelques problèmes courants pour vérifier la fonctionnalité de revue

import os,sys   # E401: Plusieurs imports sur une seule ligne (problème de style)
import json

def processData(data):  # N802: Le nom de fonction doit être en snake_case
    x = 1  # F841: Variable locale x assignée mais jamais utilisée
    result=[]  # E225: Espace manquant autour de l'opérateur d'affectation
    for i in data:
        if i > 0:
            result.append(i)
        elif i == 0:
            pass
        else:
            result.append(-i)
    return result

class myClass:  # N801: Le nom de classe doit être en CamelCase
    pass

Lancer la revue :

cd scripts/
python check_python.py tests/test_sample.py

Sortie :

{
  "status": "success",
  "file": "test_sample.py",
  "grade": "B",
  "syntax_ok": true,
  "style_count": 5,
  "error_count": 4,
  "warning_count": 1,
  "complex_functions": []
}
Autres extensions