Skill Revisión de código
Este proyecto construye un Skill de revisión de código: después de que el usuario sube archivos de código, analiza automáticamente la calidad del código, problemas de estilo y posibles bugs.
Objetivo: dominar la integración de la cadena de herramientas y la generación de informes de problemas estructurados.
Análisis de requisitos del proyecto
| Funciones | Idiomas compatibles | Herramientas |
|---|---|---|
| Verificación de sintaxis | Python | py_compile (integrado) |
| Verificación de estilo de código | Python | flake8 |
| Análisis de complejidad del código | Python | radon |
| Verificación de JavaScript | JS/TS | eslint(npx) |
| Informe integral de problemas | Todos | Script de agregación personalizado |
Estructura de directorios
code-reviewer/
├── SKILL.md
└── scripts/
├── requirements.txt
├── check_python.py
├── check_js.py
└── generate_report.py
Script de verificación de código Python
Ejemplo
# Ruta del archivo: scripts/check_python.py
import subprocess
import sys
import json
import os
def ensure_tools():
"""Asegurar que las herramientas de verificación estén instaladas"""
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:
"""Verificar la sintaxis de 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:
"""Ejecutar flake8 para verificar el estilo del código y devolver la lista de problemas"""
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
)
issues = []
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:
"""Usar radon para analizar la complejidad de las funciones y devolver las funciones de alta complejidad"""
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, [])
# Solo devolver funciones con grado de complejidad C o superior (complejidad > 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:
"""Ejecutar la revisión completa del código Python"""
if not os.path.exists(file_path):
return {"status": "error", "message": f"El archivo no existe: {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 []
# Calcular la calificación general
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": syntax["passed"],
"syntax_errors": syntax["errors"],
"style_issues": style[:20], # Mostrar como máximo 20 elementos
"style_count": len(style),
"error_count": error_count,
"warning_count": warning_count,
"complex_functions": complexity
}
if __name__ == "__main__":
result = review_python(sys.argv[1] if len(sys.argv) > 1 else "")
print(json.dumps(result, ensure_ascii=False, indent=2))
import subprocess
import sys
import json
import os
def ensure_tools():
"""Asegurar que las herramientas de verificación estén instaladas"""
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:
"""Verificar la sintaxis de 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:
"""Ejecutar flake8 para verificar el estilo del código y devolver la lista de problemas"""
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
)
issues = []
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:
"""Usar radon para analizar la complejidad de las funciones y devolver las funciones de alta complejidad"""
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, [])
# Solo devolver funciones con grado de complejidad C o superior (complejidad > 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:
"""Ejecutar la revisión completa del código Python"""
if not os.path.exists(file_path):
return {"status": "error", "message": f"El archivo no existe: {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 []
# Calcular la calificación general
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": syntax["passed"],
"syntax_errors": syntax["errors"],
"style_issues": style[:20], # Mostrar como máximo 20 elementos
"style_count": len(style),
"error_count": error_count,
"warning_count": warning_count,
"complex_functions": complexity
}
if __name__ == "__main__":
result = review_python(sys.argv[1] if len(sys.argv) > 1 else "")
print(json.dumps(result, ensure_ascii=False, indent=2))
Salida:
{
"status": "success",
"file": "ejemplo_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": []
}
Contenido completo de SKILL.md
--- 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 行,未发现语法错误和明显风格问题。
Casos de prueba
Ejemplo
# Ruta del archivo: scripts/tests/test_sample.py (archivo de muestra para probar el Skill de revisión)
# Contiene intencionalmente algunos problemas comunes para verificar la función de revisión
import os,sys # E401: Múltiples import en la misma línea (problema de estilo)
import json
def processData(data): # N802: El nombre de la función debe ser snake_case
x = 1 # F841: La variable local x se asigna pero no se usa
result=[] # E225: Falta espacio alrededor del operador de asignación
for i in data:
if i > 0:
result.append(i)
elif i == 0:
pass
else:
result.append(-i)
return result
class myClass: # N801: El nombre de la clase debe ser CamelCase
pass
# Contiene intencionalmente algunos problemas comunes para verificar la función de revisión
import os,sys # E401: Múltiples import en la misma línea (problema de estilo)
import json
def processData(data): # N802: El nombre de la función debe ser snake_case
x = 1 # F841: La variable local x se asigna pero no se usa
result=[] # E225: Falta espacio alrededor del operador de asignación
for i in data:
if i > 0:
result.append(i)
elif i == 0:
pass
else:
result.append(-i)
return result
class myClass: # N801: El nombre de la clase debe ser CamelCase
pass
Ejecutar la revisión:
cd scripts/ python check_python.py tests/test_sample.py
Salida:
{
"status": "success",
"file": "test_sample.py",
"grade": "B",
"syntax_ok": true,
"style_count": 5,
"error_count": 4,
"warning_count": 1,
"complex_functions": []
}
Otras extensiones