Formater du JSON

Ce qui survit à l'aller-retour

Formater, c'est analyser puis réécrire, et les nombres sont la seule partie reprise telle que vous l'avez tapée. Cela va au-delà du cas des grands entiers que compte le bandeau : tout nombre dont l'écriture JavaScript la plus courte diffère de la vôtre est réécrit à partir de sa source, si bien que 1.10 garde son zéro final, 1e5 reste en notation exponentielle et un zéro négatif reste négatif. Seuls les entiers non sûrs sont comptés dans l'avertissement, car ce sont eux pour lesquels l'alternative serait une corruption silencieuse plutôt qu'une écriture simplement réarrangée.

Les chaînes ne sont pas reprises telles quelles. Les séquences d'échappement sont décodées à la lecture du document et réécrites à neuf à l'impression : \u0041 revient sous la forme A et une barre oblique échappée revient sans échappement. La valeur est identique, les octets non. Cela ne compte que dans une seule situation, mais là, cela compte beaucoup : si un outil en aval compare deux fichiers JSON octet par octet, passer l'un d'eux dans un formateur n'est pas une opération neutre.

Deux comportements au niveau des objets méritent d'être connus avant de se fier à un reformatage. Les clés en double sont résolues en silence, la dernière l'emportant, exactement comme le fait l'analyseur du navigateur — un document contenant deux champs "id" se formate sans protester et revient avec un seul, sans que rien ne signale l'existence de l'autre. Et l'ordre des clés n'est celui de votre fichier que pour les clés qui ne sont pas des entiers : un objet contenant "1", "2" et "name" revient avec les clés numériques en premier, dans l'ordre numérique, car c'est ainsi que JavaScript lui-même ordonne les propriétés d'un objet. Les clés ordinaires gardent l'ordre dans lequel vous les avez écrites.

Si vous cherchez autre chose

Si vous avez affaire à un tsconfig.json, à une configuration ESLint ou à un fichier de paramètres VS Code, cette page signalera les commentaires et les virgules finales au lieu de formater autour : c'est la bonne réponse pour un outil JSON, mais ce n'est pas le bon outil pour votre fichier. Ce sont des fichiers JSONC, que votre éditeur sait déjà lire ; en ligne de commande, json5 et dasel les lisent tous deux sans prétendre qu'il s'agit de JSON.

Pour tout ce qui va au-delà de la réindentation, un formateur n'est pas le bon type d'outil. jq fait en une seule expression ce qu'aucune zone de collage ne permet : jq -S . trie les clés de chaque objet pour pouvoir comparer deux réponses, jq 'del(.token)' retire un champ avant de montrer une charge utile à qui que ce soit, et jq -c réduit un tableau d'objets au JSON Lines qu'attend un pipeline. Il lit aussi un fichier plutôt que le presse-papiers, ce qui fait toute la différence dès que le document dépasse ce que vous pouvez sélectionner confortablement.