Formatear XML

Por qué cambiar la sangría de un XML es más arriesgado de lo que parece

En XML, los espacios en blanco son significativos por defecto, y esto es lo que sorprende a la gente. A diferencia de JSON, donde el formato no tiene coste, un analizador de XML está obligado a informar de los espacios y saltos de línea entre elementos como contenido de texto: es el esquema, si lo hay, el que indica que se pueden ignorar. Así que cambiar la sangría de un documento lo modifica de verdad; en la mayoría de los archivos de configuración y de datos eso no le importa a nadie, pero en documentos con contenido mixto (texto y elementos juntos, como en XHTML o DocBook) puede alterar lo que dice el documento.

Por eso, al formatear aquí se deja intacto lo que debe quedar intacto. Un elemento con xml:space="preserve" conserva su contenido exactamente como está escrito, porque ese atributo existe justamente para indicarlo. Las secciones CDATA pasan sin tocarse: existen para contener texto que no debe interpretarse, y reformatear su interior lo corrompería. Las referencias a entidades se quedan como referencias, sin expandirse en los caracteres que representan.

Los espacios de nombres se conservan exactamente como están escritos: prefijos, declaraciones y los elementos a los que están vinculados. Parece obvio y no lo es: un formateador que normaliza los prefijos, o que mueve las declaraciones adonde cree que deben ir, produce un documento técnicamente equivalente que falla con herramientas que comparan los prefijos literales. También se mantiene el orden de los atributos, aunque para XML no tenga significado, por la misma razón: un diff contra la versión anterior vale más que la prolijidad.

Lo que se comprueba al formatear es que el XML esté bien formado: todas las etiquetas cerradas, bien anidadas, un solo elemento raíz, caracteres válidos, y los signos & y los corchetes angulares correctamente escapados. Es el más bajo de los dos niveles de XML. Un documento puede estar perfectamente bien formado y aun así no ser válido según la DTD o el esquema que lo rige, y eso no lo revela ningún formateo.

Si buscas otra cosa

xmllint --format in.xml hace lo mismo en la línea de comandos y ya viene instalado en la mayoría de los sistemas Unix; xmlstarlet fo --indent-tab da más control sobre la propia sangría. Ambos manejan archivos mucho más grandes de lo que una página puede mantener en memoria.

Cuando el documento tiene que compararse, firmarse o almacenarse en forma canónica, formatear es justamente la operación equivocada. XML canónico (xmllint --c14n) produce la única forma normalizada a la que se reducen dos documentos equivalentes, y de eso dependen las firmas digitales sobre XML. Embellecer un documento firmado rompe su firma, y esa es la forma más cara de aprenderlo.