Manual de Referencia: gaff

Gaff — Linter Pedagógico de Estilo Arquitectónico y Convenciones Cátedra con Autofix¶

1. Propósito y Filosofía Pedagógica¶

La herramienta gaff forma parte del ecosistema oficial de software de la cátedra. Su diseño sigue principios pedagógicos rigurosos:

1. Evidencia Técnica Directa: Todo diagnóstico se fundamenta en la norma ISO C (C11/C23), en el modelo de memoria del sistema o en convenciones arquitectónicas formales.

2. Acción Correctiva Concreta: Cada advertencia incluye la prescripción técnica inmediata para resolver el defecto sin recurrir a conjeturas.

3. Autonomía del Estudiante: Facilita la autoevaluación local antes de la entrega final del trabajo práctico.

4. Objetividad Docente: Estandariza la corrección automática removiendo discrepancias subjetivas en la evaluación.

2. Instalación y Verificación del Entorno¶

2.1 Requisitos Previos del Sistema¶

Instalá los paquetes del sistema requeridos según tu distribución o entorno:

2.2 Métodos de Instalación de gaff¶

Podés instalar gaff mediante cualquiera de los siguientes métodos estándar:

2.3 Autocompletado en la Shell¶

La interfaz CLI de gaff cuenta con autocompletado nativo para comandos, flags y archivos. Para configurarlo permanentemente en tu shell:

# Configuración automática en Bash / Zsh / Fish
gaff --install-completion

# Para cargar el autocompletado en la sesión actual de inmediato:
source ./install_tools.sh

2.4 Verificación del Entorno con doctor¶

Toda herramienta del ecosistema cuenta con el subcomando unificado doctor. Ejecutalo para auditar el estado del entorno:

gaff doctor

Comprobaciones Ejecutadas por el Diagnóstico:¶

• Compilador C: Verifica disponibilidad de gcc o clang con soporte de estándares C11 y C23.

• Depurador y Core Dumps: Comprueba que gdb esté instalado y que ulimit -c permita generación de core dumps.

• Herramientas de Memoria: Valida la presencia de valgrind y librerías libasan/libubsan.

• Formateo y Estilo: Verifica el binario clang-format (versión 16+).

• Sandboxing de Kernel: Audita permisos no privilegiados de bwrap (Bubblewrap namespaces).

• Generador de Tipografía y Documentos: Comprueba typst ($\ge 0.11$) y dot (Graphviz).

Matriz de Resolución de Problemas:¶

3. Referencia Completa de Comandos CLI¶

A continuación se detallan los subcomandos principales disponibles en gaff:

4. Tutorial Paso a Paso con Ejemplos Reales¶

Caso de Estudio¶

Considerá el siguiente fragmento de código representativo:

1
2
3
4
5
6
// Código con violaciones de estilo detectadas por GAFF
void FuncionPrueba(int a){ // 0x000Eh (camelCase), 0x000Bh (llave K&R)
    if(a>0){               // 0x0004h (falta espacio en if), 0x000Bh
        int* ptr=&a;       // 0x0006h (asterisco pegado a tipo)
    }
}

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

gaff check src/ include/ [-r / --recursive]

Salida Obtenida en Consola¶

⚠️ Se encontraron 4 violaciones de estilo en src/prueba.c:
┌────────────────────┬─────────┬───────────────────────────────────────┬────────┐
│ Ubicación          │ Regla   │ Mensaje                               │ Fix    │
├────────────────────┼─────────┼───────────────────────────────────────┼────────┤
│ prueba.c:1:6       │ 0x000Eh │ Función 'FuncionPrueba' no snake_case │ manual │
│ prueba.c:1:26      │ 0x000Bh │ Llave '{' K&R en vez de Allman        │ ✓ auto │
│ prueba.c:2:5       │ 0x0004h │ Falta espacio tras 'if'               │ ✓ auto │
│ prueba.c:3:9       │ 0x0006h │ Formato puntero 'int* ptr'            │ ✓ auto │
└────────────────────┴─────────┴───────────────────────────────────────┴────────┘
💡 Ejecutá 'gaff fix src/' para corregir automáticamente los problemas marcados con '✓ auto'.

5. Ejercicios Prácticos y Desafíos¶

Practicá el uso avanzado de gaff resolviendo los siguientes ejercicios:

6. Integración en el Flujo de Trabajo y Makefile¶

Para incorporar gaff de forma automática a tu flujo de desarrollo, agregá la siguiente regla en el Makefile de tu proyecto:

check-gaff:
	@echo "=== Ejecutando verificación con gaff ==="
	gaff check src/ include/

.PHONY: check-gaff

Ejecutá make check-gaff antes de cada commit para mantener que tu código conserve el estado de aprobación.

7. Arquitectura Interna y Mecanismo Técnico¶

La herramienta gaff implementa un motor de alta precisión basado en:

• Tecnología Núcleo: libclang / Clang-Format 18 Driver + Custom AST Style Rules Engine (Allman, snake_case).

• Aislamiento y Determinismo: Diseñada para operar sin efectos colaterales en entornos de integración continua (CI), terminales de estudiantes y servidores docentes headless.

• Manejo de Errores Pedagógico: Todo fallo de sintaxis, memoria o lógica se traduce en una acción prescriptiva concreta con su respectiva justificación técnica.

8. Integración y Conexión con el Ecosistema¶

Diagrama de Flujo e Interoperabilidad¶

Matriz de Intercambio de Datos¶

• dredd (calificación de estilo) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | ripley, spunkmeyer, dredd | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

Podés encadenar gaff con otras herramientas del ecosistema en una única línea de comando:

# Pipeline de integración típico
gaff fix -r src/ include/ && ripley check src/

9. Extensión, Desarrollo de Plugins y API Python¶

Para crear tus propias reglas, conectores de evaluación o integrar gaff programáticamente en pipelines de CI/CD:

• 👉 Consultá la guía completa: Guía de Extensión y Creación de Plugins