Formateador de YAML

Antes y después

Entrada desordenada:

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

Formateado (2 espacios, estilo en bloque):

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

Opciones de formato

Reglas de entrecomillado

El entrecomillado mínimo suele ser lo que quieres: las cadenas quedan sin comillas salvo que dejarlas desnudas sea peligroso. El formateador añade comillas automáticamente para:

• Booleanos heredados como cadenas: yes, no, on, off, y, n. YAML 1.2 ya los lee como cadenas, pero muchos analizadores siguen YAML 1.1, donde un no sin comillas se convierte en false. El formateador siempre los entrecomilla en la salida, así que el famoso bug de Noruega (NO leído como false en una lista de países) no puede morder a quien consuma tu archivo.
• Números como cadenas: '007', '3.14'. Sin comillas se analizarían como enteros o decimales.
• Cadenas que contienen caracteres como :, #, [, { o espacios iniciales, donde una salida desnuda cambiaría la estructura.

Limpiezas que obtienes en cada ejecución

• Espacios al final de línea. Se eliminan.
• Indentación mezclada o irregular. Se normaliza al ancho de indentación que elijas.
• Líneas en blanco dentro de colecciones. Se eliminan.
• Tabuladores en la indentación. YAML los prohíbe; el analizador rechaza la entrada con un error claro que señala la línea, para que puedas corregirla en lugar de publicar un archivo que otros analizadores rechazarán.

Comentarios, anclas y claves de fusión

El formateo normaliza el modelo del documento, y eso tiene límites que conviene conocer antes de hacer commit:

• Los comentarios se eliminan. El analizador resuelve el documento a datos, así que los comentarios con # no sobreviven al formateo. Guarda una copia si tus comentarios importan.
• Las anclas y los alias se resuelven. Los nodos compartidos mediante un alias siguen compartidos, pero se vuelven a emitir con nombres generados como &ref_0; los nombres de ancla originales no se conservan.
• Las claves de fusión (<<:) se resuelven en mapeos normales con los valores fusionados en su sitio.

Flujos multidocumento

Se admiten flujos con varios documentos: cada documento se formatea de forma independiente y se vuelve a unir con el separador ---, hasta 100 documentos por ejecución.