Comment comparer deux fichiers JSON

La réponse courte

1. Ouvrez le Formateur JSON, collez le premier fichier, réglez l'indentation sur deux espaces et cochez Trier les clés de chaque objet. Copiez le résultat.
2. Ouvrez le Comparateur de textes et collez-le dans la zone de gauche.
3. Faites de même avec le second fichier, dans la zone de droite.

Ce qui s'allume maintenant est réel : une valeur qui a changé, une clé apparue, une entrée partie. Les différences de mise en forme et les clés réordonnées qui auraient noyé un diff ordinaire ont disparu, parce que les deux côtés étaient écrits pareil avant que la comparaison commence.

Aucune des deux pages n'a la moindre fonction réseau — bon à savoir, puisque le JSON que l'on compare est si souvent un fichier de configuration avec ses identifiants encore dedans.

Pourquoi un diff JSON brut n'est presque que du bruit

JSON se moque des espaces, et il ne donne aucun sens à l'ordre des clés. Le même document peut tenir en une ligne ou en quatre cents, les clés dans l'ordre où on les a tapées ou dans celui qu'une bibliothèque a émis — et les outils réécrivent tout cela librement. Un côté minifié, l'autre déplié ; un côté enregistré à la main, l'autre par un sérialiseur qui trie par ordre alphabétique : un diff de lignes voit deux fichiers étrangers.

Les deux pires cas suffisent à la démonstration. Un fichier minifié est une ligne, donc un diff contre lui est une seule ligne changée, gigantesque — vrai et inutile. Et deux fichiers au même contenu dans un autre ordre se comparent comme tout-a-changé, quand la réponse honnête serait « rien ».

Ce que la forme canonique du formateur répare

Passer les deux fichiers par le même formateur avec les mêmes réglages est exactement ce qu'il faut à un diff : une écriture par document.

• La même indentation met chaque clé sur sa propre ligne, si bien que le diff travaille ligne à ligne et que son marquage des mots peut pointer la seule valeur qui a changé dans une ligne.
• Les clés triées mettent les deux côtés dans le même ordre, et l'ordre cesse d'être une différence. Le tri suit la façon dont les clés se lisent, pas les points de code — item2 avant item10 — et il s'applique à l'identique des deux côtés.
• Rien d'autre ne bouge. Ce formateur garde les nombres tels que vous les avez écrits et garde les clés en double plutôt que de les trancher — la canonisation ne peut donc pas inventer elle-même une différence. Le guide du formateur explique pourquoi c'est plus rare que cela ne devrait l'être.

Une réserve honnête : la sortie triée est le document avec ses clés déplacées. Si un outil en aval tient à l'ordre des clés — peu le font, mais il en existe — traitez les copies triées comme la chose comparée, pas comme un remplacement des originaux.

Lire le résultat, et l'emporter

Le comparateur marque les lignes retirées à gauche, les ajoutées à droite, et surligne dans une ligne changée les mots qui diffèrent — sur une forme canonique, c'est typiquement la seule valeur passée de false à true. Le milieu inchangé se replie en un compte, si bien qu'une configuration de deux mille lignes avec trois retouches se lit comme trois courts passages.

Le téléchargement est un correctif unifié, un .patch — le format que la revue de code comprend. Il décrit les formes canoniques, ce qui est en général ce qu'une revue veut de toute façon : le changement, sans le reformatage.

La même recette marche pour tout ce que les deux pages parlent. YAML et XML se canonisent pareil ; et pour deux fichiers de même forme venus de sources différentes, les interrupteurs d'ignorance du comparateur — espaces, casse, lignes vides — sont une version plus légère de la même idée.

Si vous faites cela chaque semaine

Formater deux fois, coller deux fois — les étapes vivent sur deux pages parce que chaque page fait un travail, et que chacune peut prouver seule que rien de ce que vous avez collé n'est allé nulle part. Mais les deux sont libres : licence MIT, des modules ES sans dépendances — le parseur du formateur garde l'ordre des clés et les chiffres, le diff est l'algorithme de Myers — chacun avec un README qui l'explique.

Si cela fait partie de vos journées, pointez un agent de code vers le dépôt et demandez-lui une page à deux zones qui canonise en comparant — parseJson, printJson et compareText sont à trois imports de là. Les modules ont été écrits pour être lus, et les emporter est exactement ce à quoi sert la licence.