Formatador de XML

Um formatador construído sobre expressões regulares — inserindo uma quebra de linha antes de cada `<` e indentando com base em uma contagem contínua de tags abertas — funciona razoavelmente em XML simples escrito à mão e falha em documentos do mundo real por razões fáceis de passar despercebidas até causarem um arquivo corrompido. Uma seção CDATA, escrita como `<![CDATA[...]]>`, existe especificamente para conter texto arbitrário que poderia ele mesmo conter caracteres parecidos com tags, e uma expressão regular procurando `<` não tem como saber que deveria ignorar tudo entre esses marcadores em vez de tratar o conteúdo como estrutura. Comentários carregam o mesmo risco, e valores de atributo são ainda piores: um atributo como `note="a > b"` contém um caractere `>` literal que um escaneador ingênuo pode confundir com o fim da tag, truncando-a silenciosamente no lugar errado.

Formatar XML corretamente significa que o escaneador precisa reconhecer essas regiões especiais — blocos CDATA, comentários, instruções de processamento, declarações DOCTYPE, e valores de atributo entre aspas — antes de procurar qualquer coisa parecida com estrutura de tags, para que seu conteúdo seja transportado byte a byte em vez de reinterpretado como marcação.

Esta ferramenta verifica se cada tag está corretamente fechada e corretamente aninhada — as regras estruturais que tornam um documento XML "bem-formado" — e relata a tag específica desbalanceada ou não fechada quando essa verificação falha. O que não faz é validar o documento contra um DTD ou um XML Schema (XSD), que adicionalmente verificaria se elementos, atributos e seus valores específicos se conformam às regras de um tipo de documento particular — se um atributo obrigatório está presente, se um elemento aparece no contexto correto, se um valor corresponde a um tipo de dado esperado. Isso é uma verificação genuinamente diferente e mais elaborada que exige o próprio documento de esquema como uma entrada adicional, não algo que um formatador de propósito geral possa inferir apenas do XML.

XHTML rigoroso é XML válido e formata corretamente aqui, mas o HTML comum do mundo real não é, por razões embutidas na própria especificação do HTML: elementos vazios como `<br>` e `<img>` nunca são fechados e não têm nenhuma tag de fechamento de jeito nenhum, várias tags têm tags de fechamento opcionais que navegadores inferem automaticamente, e navegadores toleram aninhamento malformado que a análise XML rigorosa rejeitaria diretamente. Um formatador XML rigoroso aplicado a HTML típico relataria erros em toda página completamente normal e bem-formada, que é precisamente por isso que HTML tem um formatador separado construído em torno de um analisador HTML real que entende essas regras específicas de HTML em vez de tratar o documento como XML rigoroso.

JSON substituiu o XML como a escolha padrão para novas APIs web, mas grande parte da infraestrutura foi construída antes dessa mudança e ainda roda sobre ele: serviços web SOAP, feeds RSS e Atom, imagens SVG (que são elas mesmas XML), formatos de documento do Office internamente, e uma longa cauda de sistemas empresariais e formatos de configuração anteriores à popularidade do JSON. Qualquer um se integrando com um desses sistemas mais antigos ou mais formais ainda precisa ler, depurar e produzir XML bem-formado, que é precisamente o público a que um formatador de XML dedicado ainda serve mesmo com o XML tendo recuado no design de novas APIs.