Formater du XML

Pourquoi réindenter du XML est plus risqué qu'il n'y paraît

En XML, les espaces blancs sont significatifs par défaut, et c'est ce qui surprend le plus. Contrairement au JSON, où la mise en forme ne change rien, un analyseur XML est tenu de signaler les espaces et retours à la ligne entre les éléments comme du contenu textuel — c'est le schéma, s'il existe, qui indique qu'on peut les ignorer. Réindenter un document le modifie donc réellement : pour la plupart des fichiers de configuration et de données, cela n'a aucune importance, mais pour les documents à contenu mixte — texte et éléments côte à côte, comme en XHTML ou en DocBook — cela peut changer ce que dit le document.

La mise en forme laisse donc intact ce qui doit l'être. Un élément portant xml:space="preserve" conserve son contenu exactement tel qu'il est écrit, car cet attribut existe précisément pour l'exiger. Les sections CDATA sont transmises sans modification : elles servent à contenir du texte qui ne doit pas être interprété, et les reformater les corromprait. Les références d'entité restent des références au lieu d'être remplacées par les caractères qu'elles représentent.

Les espaces de noms sont conservés exactement tels qu'ils sont écrits — préfixes, déclarations et éléments auxquels ils sont liés. Cela paraît évident, et pourtant non : un formateur qui normalise les préfixes, ou qui déplace les déclarations là où il estime qu'elles doivent se trouver, produit un document techniquement équivalent qui échoue avec les outils qui comparent les préfixes littéralement. L'ordre des attributs est lui aussi conservé, bien que XML le considère sans importance, pour la même raison : un diff avec la version précédente vaut plus qu'un fichier bien rangé.

Ce qui est vérifié pendant la mise en forme, c'est la bonne formation : chaque balise fermée, correctement imbriquée, un seul élément racine, des caractères autorisés, des esperluettes et chevrons correctement échappés. C'est la moins exigeante des deux conditions du XML. Un document peut être parfaitement bien formé et pourtant invalide au regard de la DTD ou du schéma qui le régit, ce qu'aucune mise en forme ne révélera.

Si vous cherchez autre chose

xmllint --format in.xml fait la même chose en ligne de commande et est déjà installé sur la plupart des systèmes Unix ; xmlstarlet fo --indent-tab offre plus de contrôle sur l'indentation elle-même. Tous deux gèrent des fichiers bien plus volumineux que ce qu'une page peut garder en mémoire.

Quand le document doit être comparé, signé ou stocké sous forme canonique, la mise en forme n'est pas du tout la bonne opération. Le XML canonique — xmllint --c14n — produit l'unique forme normalisée à laquelle se ramènent deux documents équivalents, et c'est sur elle que reposent les signatures numériques XML. Indenter un document signé casse sa signature, et c'est la façon la plus coûteuse de l'apprendre.