Sangría y ancho de línea en YAML

Sangría coherente

Dos espacios son habituales y mantienen compactos los archivos. No uses tabulaciones para definir niveles.

Los elementos de una secuencia deben alinearse y su contenido anidado debe quedar un nivel más profundo.

Ancho de línea

Dividir líneas largas puede mejorar la lectura, pero las cadenas plegadas y literales tienen semánticas distintas.

No envuelvas automáticamente texto si el sistema de destino depende de saltos de línea exactos.

Differences limpios

Usa siempre la misma configuración de serialización en el proyecto. Así, las revisiones muestran cambios de datos y no reformateo accidental.

Valida el archivo después de aplicar cualquier formateador.

Flujo de trabajo fiable paso a paso

Trata la sangría y el ancho de línea en YAML como una transformación de datos con una entrada, una estructura esperada y un destino definidos. Trabaja sobre una copia, valida antes de cambiar la representación y aísla una muestra mínima. Así se distinguen los fallos de sintaxis de los problemas del modelo de datos o de la aplicación.

Realiza un cambio cada vez y repite la misma validación. En una canalización automática, detén el proceso ante un error del analizador en vez de publicar un resultado parcial o inferido. Conserva la entrada original junto al artefacto generado cuando necesites trazabilidad.

• Empieza con una entrada representativa y conserva una copia intacta para poder revisar o repetir la transformación.
• Inspecciona la estructura analizada, no solo el texto visible: claves, tipos escalares, orden de listas y valores nulos son lo que recibe el sistema de destino.
• Prueba el resultado en el destino real y documenta las suposiciones sobre analizador, esquema, codificación y formato.

Ejemplo práctico y verificación

El ejemplo siguiente es deliberadamente pequeño para poder revisarlo a simple vista. Aplica el mismo método a un documento real: confirma cada clave, tipo escalar, orden de lista y límite de anidamiento antes de aceptar el resultado.

Que la conversión o minificación termine solo demuestra que la entrada pudo analizarse. Compara el valor estructurado antes y después y carga el resultado con la misma biblioteca o plataforma que lo consumirá en producción.

service:
  environment:
    LOG_LEVEL: info
    RETRIES: "3"

Límites y casos especiales

Los casos difíciles de la sangría y el ancho de línea en YAML suelen aparecer al confundir validez sintáctica con validez para la aplicación. Un analizador puede aceptar datos incompletos, ambiguos, demasiado grandes o incompatibles con el esquema de destino.

No repares ni normalices a ciegas un documento desconocido. Las claves duplicadas, tipos implícitos, alias, precisión numérica, Unicode, finales de línea y entradas enormes requieren una política explícita. Si el destino impone reglas más estrictas, prevalecen esas reglas.

Lista de comprobación para producción

Antes de publicar, prueba un documento normal, un valor vacío, datos profundamente anidados, texto no ASCII y un ejemplo malformado. Anota la versión de la herramienta o biblioteca si otro sistema debe reproducir exactamente el resultado.

Integra la validación en CI cuando los datos afecten compilaciones, despliegues, API o configuración. Revisa los cambios, conserva una copia de reversión y supervisa el primer consumidor después del despliegue.

• Empieza con una entrada representativa y conserva una copia intacta para poder revisar o repetir la transformación.
• Inspecciona la estructura analizada, no solo el texto visible: claves, tipos escalares, orden de listas y valores nulos son lo que recibe el sistema de destino.
• Prueba el resultado en el destino real y documenta las suposiciones sobre analizador, esquema, codificación y formato.

Preguntas sobre este tema