Un hallazgo es lo que devuelve una ejecución cuando una regla tiene algo que reportar. No es una calificación ni una opinión de estilo: nombra la regla, señala las líneas y enlaza el estándar del que viene, para que puedas revisar el razonamiento antes de cambiar nada.
De qué está hecho un hallazgo
| Parte | Qué te dice |
|---|---|
| La regla | El nombre de la regla que reportó, tal como aparece en el estándar |
| El estándar | A qué estándar pertenece esa regla |
| La explicación | Qué está mal aquí y por qué existe la regla |
| Presente en: | Cada línea que reportó la regla, por número |
| El fragmento | La línea señalada tal como la leyó el analizador |
| Ver estándar | Un enlace a esa regla exacta, en su propia ancla |
Un hallazgo es una regla, sin importar cuántas líneas haya tocado. Cuando una regla reportó en varias líneas se listan juntas, y el conteo de líneas aparece junto al número de hallazgos.
Los números de línea cuentan el archivo exactamente como lo recibió el analizador. Si pegas un fragmento en lugar del archivo completo, los números son los del fragmento.
Error o advertencia
| Severidad | Qué significa | Qué se espera de ti |
|---|---|---|
| Error | La regla se incumplió y el analizador puede probarlo con este archivo | Arréglalo y vuelve a ejecutar el archivo |
| Advertencia | Algo que la regla no puede resolver por su cuenta | Decide, y di qué decidiste |
Las advertencias no bloquean el análisis. Son los casos donde la respuesta correcta depende de algo que el analizador no ve —la intención, o un archivo que nunca abrió—, así que la decisión humana es el punto y no una salida de emergencia. Decidir que una advertencia no aplica aquí es un desenlace válido; dejarla sin leer no lo es.
El resultado que recibes
| Lo que dice el panel | Qué pasó |
|---|---|
| No se encontraron incumplimientos. | El código pasó las reglas aplicables al tipo seleccionado |
| El código pasó, con observaciones. | Pasó, y hay advertencias que decidir |
| Una lista de hallazgos | Al menos una regla reportó, con errores, advertencias o ambos |
| El análisis terminó con observaciones generales. | La ejecución terminó sin atribuir hallazgos a una regla: revisa la configuración de las reglas aplicables |
Que pase quiere decir que el código pasó las reglas aplicables a ese tipo de archivo. No es una afirmación de que el archivo está bien, porque una regla que ninguna máquina puede ejecutar tampoco puede reportar sobre él. Esas cuatro están en Lo que el analizador no puede revisar.
Qué hacer con uno
Arregla primero los errores. Son los que el analizador probó, y son baratos: el hallazgo nombra la línea y el estándar que hay detrás muestra la forma correcta.
Lee la regla cuando no estés de acuerdo. Cada regla dice por qué existe, y ese motivo suele ser la vía más rápida para saber si tu caso es la excepción que nombra o el error que describe. Ábrela desde Ver estándar; dónde viven las reglas está en Leer los estándares.
Vuelve a ejecutar el archivo después del arreglo. Una ejecución la cierra una ejecución limpia sobre el archivo cambiado, no el cambio en sí. Las dos quedan en El historial de análisis, así que puedes compararlas.
Reporta un hallazgo equivocado. Una regla que se dispara con código correcto es un defecto de la regla, no algo que tu proyecto tenga que rodear. Lo mismo vale para una regla que se quedó callada con algo que debía atrapar. Arreglarla en la fuente es de lo que trata Reportar un hallazgo equivocado, y cada proyecto recibe la regla corregida en su siguiente llamada.