Ir al contenido

Diagnósticos

Los diagnósticos de Biome están llenos de información, y normalmente proporcionan toda la información que necesita para entender los errores, y solucionarlos.

Los diagnósticos no sólo sirven para detectar errores, sino también para proporcionar información estructurada, advertencias y consejos.

Esta página ofrece un desglose de toda la información que puede contener un diagnóstico. Aprender todas las partes de un diagnóstico puede ayudarle a identificar las partes importantes y algunos “secretos” que se esconden tras ellas.

La gravedad del diagnóstico puede afectar a la CLI. Por ejemplo, los diagnósticos de error obligarán a la CLI a salir con un código de error.

Los diagnósticos de error tienen texto en rojo. Los diagnósticos fatales suelen emitirse cuando se produce un error inesperado dentro de Biome. En comparación con los errores, tienen la etiqueta fatal.


 FATAL  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  
   Biome exited as this error could not be handled and resulted in a fatal error. Please report it if necessary.
  

Los diagnósticos de error tienen texto en rojo. Por lo general, deben ser abordados porque emitirán un código de error cuando se encuentran por la CLI.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Los diagnósticos de advertencia tienen texto amarillo. Por lo general, deben ser atendidos. Las advertencias no son bloqueos y no impedirán que la CLI funcione.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Los diagnósticos de información tienen texto verde. Proporcionan información útil y no están destinados a bloquear la CLI.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Las etiquetas pueden verse como metadatos adjuntos a un diagnóstico, y pueden afectar a los clientes de diferentes maneras.

Los diagnósticos detallados suelen estar ocultos. A través de la CLI, puede mostrar estos diagnósticos utilizando la opción --verbose.


 VERBOSE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Los diagnósticos internos se emiten cuando se produce un error interno. Normalmente se anima a los usuarios a presentar un error cuando ven uno.


 INTERNAL  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  
   This diagnostic was derived from an internal Biome error. Potential bug, please report it if necessary.
  

Los diagnósticos reparables se emiten para aquellas situaciones particulares que pueden ser reparadas por el usuario. Suelen utilizarse para diagnósticos de pelusa que tienen una acción de código.


 FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Diagnósticos que contienen código obsoleto


 DEPRECATED  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

La categoría sirve para el diagnóstico del grupo. Opcionalmente, una categoría puede tener un enlace, por ejemplo para categorías que pertenecen a reglas de lint, como en el ejemplo siguiente.

Este diagnóstico pertenece a la categoría “check”, lo que significa que se emite al ejecutar el comando check:


check ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Este diagnóstico pertenece a la categoría “lint/a11y/noAccessKey”. El enlace lleva al usuario a la página web de la regla lint noAccessKey.


lint/a11y/noAccessKey ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Los diagnósticos pueden tener una “localización”. Una ubicación se compone de tres partes opcionales:

  • un recurso, que es el origen que emitió el diagnóstico;
  • código fuente del archivo;
  • un span (o rango de texto), normalmente la línea y la columna dentro del archivo.

La ruta del archivo suele ser la primera información que aparece, en la parte superior izquierda del diagnóstico.


path/to/file.js ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  

Esto muestra cómo se muestra el código fuente asociado a un archivo. Observa que la línea y las columnas no se muestran.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  
  > 1 │ Some source code
        ^^^^^
  

Line y column suele imprimirse junto a la ruta del archivo, y sólo se muestra cuando hay algún código fuente asociado.


path/to/file.txt:1:6 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  
  > 1 │ Some source code
        ^^^^^^
  

Cuando los diagnósticos se imprimen dentro de la terminal de un IDE, puede hacer clic en ruta/al/archivo.js:2:2, y el IDE abrirá el archivo relativo, y colocará el cursor al principio del tramo.


path/to/file.js:2:2 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  
    1 │ function name() {
  > 2 │ 	return 'lorem'
   	^^^^^^^^^^^^^^
    3 │ }
  

Además, nuestros diagnósticos pueden almacenar avisos. Los avisos son mensajes adicionales que pueden añadirse al mensaje original.

Estos consejos son de diferentes tipos y formas. Normalmente, los consejos siempre se imprimen, a menos que sean consejos verbales.


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

   This diagnostic message is displayed in a color that reflects its severity.
  
   An error message.
  
   A warning message.
  
   An informational message.
  
  An unstyled message can introduce a command:
  
  $ biome command
  
  Messages can be grouped under a heading:
  
  Related information
  
     First message of a group.
    
     Second message of a group.
    
  Messages can also be displayed as a list:
  
  - First item
  - Second item
  
  A diff can show a suggested change:
  
  - Old·code
  + New·code
  
  A code frame can highlight a source range:
  
  > 1 │ Lorem
   ^^^
    2 │ Ipsum