Aplicador de Estilo de Código
Esta habilidad asegura que el código siga las convenciones de estilo y patrones específicos del proyecto que los linters automáticos pueden pasar por alto.
Cuándo Usar Esta Habilidad
- El usuario solicita una revisión o mejora de estilo de código
- Asegurar consistencia en toda la base de código
- Incorporar código o contribuyentes nuevos
- Revisión de código previa al commit
- El usuario menciona "estilo", "consistencia", "formato" o "convenciones"
Instrucciones
1. Detectar Guías de Estilo del Proyecto
Busca archivos de configuración de estilo:
JavaScript/TypeScript:
.eslintrc.*- Configuración de ESLint.prettierrc.*- Configuración de Prettiertsconfig.json- Opciones del compilador TypeScript.editorconfig- Configuración del editor
Python:
.pylintrc,pylint.cfg- Pylintpyproject.toml- Configuración de Black, isort.flake8- Configuración de Flake8setup.cfg- Varias configuraciones de herramientas
Ruby:
.rubocop.yml- Configuración de RuboCop
Go:
go.fmtaplicado (estándar).golangci.yml- GolangCI-Lint
Java:
checkstyle.xml- Checkstyle.editorconfig
General:
CONTRIBUTING.md- Guías de contribuciónSTYLE_GUIDE.md- Guía de estilo del proyecto.editorconfig- Configuración entre editores
Usa Glob para encontrar estos archivos y Read para entender las preferencias de estilo del proyecto.
2. Analizar Patrones de Código Existentes
Toma muestras del código existente para entender las convenciones implícitas:
Organización de archivos:
- Patrones de estructura de directorios
- Convenciones de nombres de archivo (camelCase, kebab-case, snake_case)
- Organización de importaciones/exportaciones
Estructura del código:
- Orden de clases/funciones
- Ubicación de métodos públicos vs privados
- Lugar de declaración de constantes/variables
Formato:
- Sangría (espacios vs tabs, tamaño)
- Límites de longitud de línea
- Uso de líneas en blanco
- Estilos de comentarios
Nombres:
- Nombres de variables (camelCase, snake_case)
- Nombres de clases (PascalCase, mayúsculas)
- Nombres de constantes (UPPER_CASE, etc.)
- Patrones de nombres de archivos
Usa Grep para encontrar patrones comunes en archivos similares.
3. Más Allá de los Linters: Buscar Patrones
Concéntrate en problemas de estilo que las herramientas automáticas a menudo pasan por alto:
Consistencia de nombres:
- Variables booleanas: prefijos
is,has,should - Manejadores de eventos: patrones
handle*,on* - Getters/setters: consistencia
get*,set* - Nombres de colecciones: plural vs singular
- Acrónimos: mayúsculas consistentes
Organización del código:
- Funciones relacionadas agrupadas
- Estructura de archivos consistente entre módulos
- Orden lógico (público antes que privado, etc.)
- Separación de preocupaciones
Comentarios y documentación:
- Integridad de JSDoc/docstring
- Consistencia del estilo de comentarios
- Formato de TODO/FIXME
- Comentarios en línea vs en bloque
Patrones de importación/exportación:
- Orden de importaciones (externas, internas, relativas)
- Exportaciones con nombre vs por defecto
- Consistencia en la desestructuración
- Patrones de alias
Manejo de errores:
- Formato consistente de mensajes de error
- Uso de clases de error
- Patrones de try/catch
- Formato de registro (logging)
Uso de tipos (TypeScript/lenguajes tipados):
- Tipos explícitos vs inferidos
- Preferencia
interfacevstype - Nombres de genéricos (T, K, V vs descriptivos)
- Manejo de null/undefined
4. Identificar Anti-patrones Comunes
Señala olores de código y anti-patrones:
Números mágicos:
// Mal
if (status === 200) { }
// Bien
const HTTP_OK = 200;
if (status === HTTP_OK) { }
Comprobaciones de null inconsistentes:
// Inconsistente
if (user === null) { }
if (!data) { }
if (typeof result === 'undefined') { }
// Consistente
if (user === null) { }
if (data === null) { }
if (result === undefined) { }
Ternarios anidados:
// Difícil de leer
const value = a ? b ? c : d : e;
// Mejor
let value;
if (a) {
value = b ? c : d;
} else {
value = e;
}
Listas largas de parámetros:
# Difícil de mantener
def create_user(name, email, age, address, phone, ...):
# Mejor
def create_user(user_data: UserData):
5. Verificar Convenciones Específicas del Proyecto
Busca patrones únicos de este proyecto:
- Nombres personalizados para dominios específicos (ej., "repo" vs "repository")
- Librerías preferidas para tareas comunes
- Patrones arquitectónicos (MVC, capa de servicios, etc.)
- Nombres y estructura de archivos de prueba
- Patrones de configuración
Lee CONTRIBUTING.md, README.md o documentos similares para pautas explícitas.
6. Generar Recomendaciones de Estilo
Para cada problema, proporciona:
Código actual:
function getData(id) {
const d = fetch('/api/users/' + id);
return d;
}
Problema:
- Nombre inconsistente (
getDatavs otras funciones usanfetch*) - Nombre de variable de una sola letra (
d) - Concatenación de cadenas en lugar de plantillas literales
Recomendado:
function fetchUser(id) {
const userData = fetch(`/api/users/${id}`);
return userData;
}
7. Priorizar Problemas
Ordena por impacto:
Alta prioridad (Consistencia):
- Inconsistencias de nombres entre funciones similares
- Sangría o formato mixto
- Manejo de errores inconsistente
Prioridad media (Legibilidad):
- Números/cadenas mágicas
- Nombres de variables poco claros
- Documentación faltante
Baja prioridad (Bueno tener):
- Formato de comentarios
- Orden de importaciones
- Líneas en blanco extra
8. Sugerir Herramientas Automatizadas
Recomienda herramientas para aplicar estilos:
JavaScript/TypeScript:
npm install --save-dev prettier eslint
npx prettier --write .
npx eslint --fix .
Python:
pip install black isort flake8
black .
isort .
Go:
go fmt ./...
golangci-lint run
Ruby:
gem install rubocop
rubocop -a
9. Crear o Actualizar EditorConfig
Sugiere .editorconfig si falta:
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.{js,ts,jsx,tsx}]
indent_style = space
indent_size = 2
[*.py]
indent_style = space
indent_size = 4
[*.go]
indent_style = tab
10. Lista de Verificación de Revisión de Estilo
Al revisar código por estilo:
- Los nombres siguen las convenciones del proyecto
- La sangría y el formato son consistentes
- Las importaciones están organizadas correctamente
- Comentarios donde sean necesarios, no excesivos
- No hay números o cadenas mágicas
- El manejo de errores es consistente
- La organización de archivos coincide con la estructura del proyecto
- No hay olores de código evidentes
- Las anotaciones de tipo son consistentes (si aplica)
- Las pruebas siguen las convenciones de pruebas
Mejores Prácticas
- Consistencia sobre perfección: Sigue los patrones existentes incluso si no son ideales
- Documenta las decisiones: Añade guías de estilo para casos ambiguos
- Automatiza cuando sea posible: Usa Prettier, Black, gofmt, etc.
- Sé pragmático: No refactorices código funcional solo por el estilo
- Acuerdo del equipo: Alinéense en los estilos que importan
- Mejora incremental: Corrige estilos en archivos modificados, no todos a la vez
- Legibilidad primero: El estilo sirve a la legibilidad, no al revés
Conflictos Comunes de Estilo
Tabs vs Espacios
- Verifica
.editorconfigo archivos existentes - En caso de duda, usa la mayoría del proyecto
Estilo de Comillas (Simples vs Dobles)
- JavaScript: Comúnmente simples (
') - Python: Cualquiera, sé consistente
- Go: Siempre dobles (
") - Sigue la configuración del linter si está presente
Puntos y Coma (JavaScript)
- Verifica la mayoría del código existente
- Si está mezclado, sugiere Prettier para aplicarlos
Longitud de Línea
- Límites comunes: 80, 100, 120 caracteres
- Verifica la configuración del linter o
.editorconfig
Orden de Importaciones
- Generalmente: stdlib, externas, internas, relativas
- Usa herramientas automatizadas (isort, organize imports)
Archivos de Apoyo
reference/style-guides.md: Enlaces a guías de estilo popularesexamples/before-after.md: Ejemplos de código que muestran mejoras