Text Diff Checker: Stoppen Sie die Änderungen an den Augen, die Sie nicht sehen können

Ein WP Adminify-Kunde hat mir mal zwei Exporte seiner Plugin-Einstellungen geschickt - " vor dem Update hat alles funktioniert; danach ist das Admin-Menü kaputt Sonst hat sich nichts geändert." Zwei JSON-Blobs, jeweils ca. 340 Zeilen, ich habe sie nebeneinander gelesen, zweimal, und bin zuversichtlich mit ihm einer Meinung: identisch Es hat sich nichts geändert Muss unser Bug sein.

Es war nicht. Als ich endlich aufhörte, meinen Augen zu vertrauen und die beiden Dateien zu diffonieren, war es in Zeile 217: Eine Menürolle war von "administrator" auf "administrator "- mit einem nachlaufenden Leerzeichen Ein unsichtbarer Charakter Ich hatte persönlich zweimal daran vorbeigelesen, denn menschliche Augen don't compare strings; sie musterpassen Formen, und administrator und administrator haben die gleiche Form.

Dieses Support-Ticket hat meine Regel dauerhaft geändert: Wenn zwei Texte länger als zehn Zeilen sind, vergleiche ich sie nicht durch Lesen. je nachdem. Ein Diff-Algorithmus hat keine Pattern-Matching-Verknüpfungen zum Narren halten - er vergleicht jedes Zeichen und meldet genau, was sich unterscheidet Die Text-Diff-Tool Auf Toolz.dev tut dies in Ihrem Browser, was bedeutet, dass Kundenkonfigurationen, Verträge und unveröffentlichter Code niemals Ihre Maschine verlassen. So funktioniert Diffing tatsächlich und wie man es gut einsetzt.

tl; dr: Vergleichen Sie Texte niemals visuell länger als ein paar Zeilen - Augen verpassen nachgestellte Leerzeichen, vertauschte Ziffern und Ein-Wort-Bearbeitungen Fügen Sie beide Versionen in die ein Text-Diff-Tool: grün = hinzugefügt, rot = entfernt, berechnet von derselben Myers-Algorithmusfamilie, die befähigt git diffdrohen einsetzen Linienmodus Für Code und Konfigurationen, Wortmodus für Prosa und Verträge. Bei strukturierten Daten ist json diff Vergleicht nach Bedeutung statt nach Text. Alles läuft clientseitig.

Wie funktioniert ein Diff-Algorithmus eigentlich?

Die Kernidee: Finden Sie die längste gemeinsame Folge (LCS) der beiden Texte - die längste Folge von Zeilen (oder Wörtern, oder Zeichen), die in beiden, in der gleichen Reihenfolge erscheint Alles in der LCS ist "unverändert." Was auch immer's in Version A übrig bleibt, ist eine Löschung; was auch immer's in Version B übrig bleibt, ist eine Ergänzung. Eine "modified" Zeile ist nur eine Löschung und eine Ergänzung, die zufällig nebeneinander liegt.

Die Standardmethode, dies effizient zu berechnen, stammt aus dem Papier von Eugene Myers 1986, "ein O(nd)-Differenzalgorithmus und seine Variationen"drohen Der elegante Teil ist das, was die Komplexität gebunden sagt: n ist die Eingabegröße, aber d ist das Anzahl der Unterschiede. Zwei nahezu identische Texte verbreiten sich fast augenblicklich, egal wie lang sie sind, denn die Arbeit des Algorithmus' skaliert mit der Art und Weise, wie unterschiedlich sie sind, und nicht nur mit der Größe. That' Warum sich das Diffundieren zweier 300-Zeilen-Konfigurationen, die sich um eine Zeile unterscheiden, sofort anfühlt - der Algorithmus tut fast nichts, genau in der Situation, in der Ihre Augen am meisten arbeiten und versagen.

Dieselbe Algorithmusfamilie ist die Standard-Engine in git diff, Gnu diffund die meisten Vergleichstools, die Sie jemals verwendet haben. (Git bietet auch patience und histogram Varianten, die manchmal mehr menschenlesbare Gruppierungen derselben Veränderungen hervorbringen - die einstellen von Änderungen ist gleich, die Darstellung ist unterschiedlich.)

Eine wichtige nicht offensichtliche Eigenschaft: Ein Diff ist nicht immer einzigartig. Wenn Sie zwischen zwei leeren Zeilen eine Leerzeile hinzufügen, ist die Leerzeile "neu" ist wirklich mehrdeutig, und verschiedene Werkzeuge können verschiedene hervorheben. Beide Antworten sind richtig.

Zeilen-, Wort- oder Zeichendiff - Welcher Modus wann?

Die Granularität, die Sie vergleichen, ändert sich, wofür die Ausgabe gut ist. Dies falsch zu machen, ist der Hauptgrund, warum die Leute die Diff-Ausgabe "gestört" finden.

konkretes Beispiel. Original: The quick brown fox jumps over the lazy dog. modifiziert: The quick red fox leaps over the lazy cat.

• Linienmodus Markiert den gesamten Satz als geändert - genau, nicht hilfreich.
• Wortmodus Highlights genau brown→red, jumps→leaps, dog→catdrohen
• Zeichenmodus ist hier übertrieben, aber es ist der einzige Modus, der fangen würde admlnistrator Vs administratordrohen

Faustregel: Strukturierter Text (eine aussagekräftige Aussage pro Zeile) will Zeilenmodus; Fließender Text will Wortmodus; Zeichenmodus ist eine Lupe, die Sie herausziehen, wenn die anderen beiden "geändert" sagen, und Sie können nicht sehen, warum. Mein Trailing-Space-Fehler ist der kanonische Fall des Charaktermodus.

Wann ist ein eigenständiges Diff-Tool besser als Git?

Gits Diff ist ausgezeichnet Für Dinge, die im selben Repository lebendrohen Eine überraschende Menge an Vergleichsarbeiten ist nicht:

Tickets unterstützen. Das Szenario aus meinem Intro - zwei Einstellungen exportiert von einem Kunden Sie' sind in keinem Repo Beides einfügen in die Text-Diff-Tool Und die Antwort erscheint in Sekunden statt zwei fehlgeschlagenen Durchlesungen.

Konfigurieren Drift. Staging nginx config vs production nginx config. herrschend .env VS das Backup von bevor die Dinge kaputt gingen. git diff Kann keine Dateien auf zwei verschiedenen Servern sehen; Kopieren und Einfügen können.

Formatierungsprüfung. Sie haben hübscher (oder phPCs oder schwarz) über eine Datei gelaufen und möchten Vertrauen, das sich geändert hat Nur Formatierungdrohen Diff the earing to the eheads and after: Wenn Sie etwas anderes als Leerzeichen, Zitate und Semikolons sehen, hat der Formatierer die Logik berührt und Sie möchten es jetzt wissen.

Zwei API-Antworten. Die Staging-Einheit gibt einen JSON-Körper zurück, die Produktion gibt einen anderen zurück und das Frontend wird nur im Staging unterbrochen. Diff die Antworten. (Für JSON speziell bevorzugen Sie die json diff- es vergleicht analysierte Struktur, so Schlüsselreihenfolge und Leerzeichen don' t erstellen falsch positive Führen Sie beide Nutzlasten durch die JSON-Formater Zuerst, wenn Sie stattdessen einen lesbaren Text diff wollen.)

Dokumente und Verträge. Ein Anbieter gibt & quot; den gleichen Vertrag mit kleineren Updates zurück." Word-mode diff ist, wie Sie feststellen, dass die Zahlungsbedingungen in einem 40-seitigen Dokument von Net 30 zu Net 15. Redakteure und Anwälte wissen das schon immer - sie nennen es eine Blackline oder Redline.

Übersetzungs- und Lokalisierungsdateien. Vergleichen von zwei Versionen von a .po Datei, um zu sehen, welche Zeichenfolgen sich tatsächlich geändert haben, bevor Sie sie an Übersetzer zurücksenden - ein echter WP-Adminify-Workflow, der die Zahlung spart, um 400 unveränderte Zeichenfolgen erneut zu übersetzen.

Der rote Faden: in dem Moment, in dem beide Versionen als Text existieren, den Sie auswählen können, antwortet ein Diff-Tool & quot; was hat sich geändert? " mechanisch Und weil das Toolz.dev clientseitig ist, fügt man eine customer' s-Konfiguration oder einen nicht unterzeichneten Vertrag ein und #39; überträgt es nirgendwo - das gleiche Argument wie der Rest des Datenschutz-First-Toolboxdrohen

Wie liest man die Diff-Ausgabe, ohne sich selbst zu täuschen?

Die Farbkonvention ist universell: Rot ist der exklusive Inhalt der alten Version (entfernt), grün ist die neue Version (hinzugefügt), unveränderter Text rendert für den Kontext. Eine geänderte Linie erscheint als rote Linie, gefolgt von ihrem grünen Ersatz.

Drei Gewohnheiten, die Diff Review tatsächlich zuverlässig machen:

Setzen Sie die Versionen in die richtigen Steckplätze. Links alt/original (oder erstes Feld), rechts neu/modifiziert Vertauschen und jede Ergänzung liest sich als Löschen - I' hat zehn Minuten lang beobachtet, wie Leute deswegen die falsche Richtung debuggen Wenn die Ausgabe rückwärts schaut, ist es das wahrscheinlich.

Entscheiden Sie, was für ein Geräusch ist, bevor Sie beginnen. Formatierter Code vergleichen? Whitespace-Änderungen sind Rauschen - normalisieren oder ignorieren YAML-Konfigurationen vergleichen? Whitespace ist Bedeutung- Einrückung ist Struktur in YAML, also validieren Sie beide Seiten in der YAML-Validator und behandeln Sie jeden Raum als Signal. Das gleiche Tool, die Gegenrichtlinie und die Auswahl von falschem vergräbt entweder die wirkliche Änderung des Lärms oder versteckt sie.

Lesen Sie jeden Hunk, nicht nur den ersten. Der Customer' s-Hinterraum war Veränderung #1 von 1. Aber wenn ein Diff vier Veränderungen zeigt und der erste Ihr Symptom erklärt, ist die Versuchung, mit dem Lesen aufzuhören, stark - und Veränderung #3 ist manchmal derjenige, der Sie nächste Woche beißt Der Diff hat bereits den harten Teil gemacht; don' t Führen Sie im letzten Schritt erneut einen menschlichen Stichprobenfehler ein.

Was kann Ihnen ein Textunterschied nicht sagen?

Es lohnt sich, ehrlich über die Grenzen zu sein:

• Verschiebte Blöcke als Löschen + Hinzufügen gelesen. Schneiden Sie eine Funktion von der Oberseite einer Datei aus und fügen Sie sie unten ein: Der Diff meldet, dass er entfernt und hinzugefügt, nicht verschoben wurde. Einige Spezialwerkzeuge erkennen Bewegungen; einfache LCS-Technik.
• Es vergleicht Text, nicht Bedeutung. 0.1 + 0.2 und 0.3 Diff als unterschiedlich (sie sind) aber auch sich benehmen Anders im Gleitkomma - und umgekehrt "key": 1 Vs "key": 1.0 Kann textlich anders, aber semantisch identisch in Ihrer Sprache sein. Strukturierter Vergleich (wie die json diff) schließt einen Teil dieser Lücke für Datenformate.
• Binärinhalte sind nicht in den Gültigkeitsbereich. Bilder, PDFs als Bytes, ausführbare Dateien - text diff braucht Text Extrahieren Sie zuerst den Text, oder verwenden Sie formatspezifische Tools.
• Fall und Codierung werden wörtlich verglichen. README ≠ readmeund ein UTF-8-Zitat ≠ ein ASCII-Gerade, obwohl sie in den meisten Schriftarten identisch aussehen. (Eine weitere Form-Muster-Falle für die Augen, ein weiterer Sieg für den Algorithmus.) vornormalisieren mit dem Gehäusekonverter Wenn der Fall für Ihren Vergleich keine Rolle spielt.

Häufig gestellte Fragen

Kann ich Dateien vergleichen oder nur Text einfügen?

der Text-Diff-Tool Funktioniert auf eingefügtem Text: jede Datei in einem beliebigen Editor öffnen, kopieren, beide Seiten einfügen Das macht sie formatunabhängig - alles, was & #39; s lesbarer Text (Code, Config, CSV, SQL, Prosa) kann verglichen werden, unabhängig von der Erweiterung.

Gibt es eine Größenbeschränkung für den Vergleich?

Die praktische Grenze ist der Speicher Ihres Geräts, da die Verarbeitung im Browser erfolgt. Dateien mit einigen tausend Zeilen vergleichen sich sofort; die Kostenskalen des Myers-Algorithmus mit der Anzahl der Unterschiede, so bleiben auch große, aber ähnliche Texte schnell. Hunderttausende von Linien mit massiven Unterschieden können einige Sekunden dauern.

Welchen Diff-Modus soll ich für Code verwenden?

Zeilenmodus. code ist natürlich ein anweisungs-pro-zeile, so dass die ausgabe auf zeilenebene sauber darauf abgebildet wird, wie sie über die änderung denken wechseln sie in den wort-oder zeichenmodus nur, wenn eine zeile als geändert gekennzeichnet wird und sie können #39; t den unterschied darin erkennen - that's normalerweise whitespace, anführungszeichen oder ein einzelnes zeichen.

Welcher Modus eignet sich am besten für Verträge und Prosa?

Wortmodus Prosaänderungen sind in der Regel Wortersetzungen und eingefügte Klauseln innerhalb langer Absätze; der Zeilenmodus würde ganze Absätze markieren und Sie auf die Jagd bringen Die Hervorhebung auf Wortebene zeigt genau an, welche Wörter sich geändert haben - der gleiche Ansatz wie bei einer legalen Blackline.

Ändert oder speichert der Diff meinen Text?

kein . Hervorhebungen nur in der gerenderten Ausgabe, Ihr Eingabetext ist unverändert, und da das Tool vollständig clientseitig läuft, wird keine Version übertragen oder gespeichert. Schließen Sie die Registerkarte und die Texte sind weg.

Warum hebt das Diff eine Linie hervor, die identisch aussieht?

Fast immer unsichtbare Zeichen: Nachfolgende Leerzeichen, Registerkarten gegen Leerzeichen, Fenster \r\n vs Unix \n Linienenden, nicht brechende Leerzeichen oder Unicode-Doppelgänger (Curly vs. Straight Zitate).Dies ist genau die Klasse der Veränderung, die menschliche Augen nicht sehen können und die Diff-Algorithmen immer erfassen - mein Trailing-Space-Support-Ticket war eines davon.

Kann es bewegten Text erkennen?

Nicht als Umzug Standard LCS-basiertes Diffing meldet einen verschobenen Block als vom alten Speicherort gelöscht und am neuen hinzugefügt, Wenn Sie einen Umzug vermuten, durchsuchen Sie den " added" Text im Original - ein exakter Treffer an anderer Stelle in der Datei bestätigt ihn.

Wie unterscheidet sich JSON Diff von Text Diff?

Text diff vergleicht Zeichen; json diff Parsen sowohl Dokumente als auch Vergleiche der Struktur. Neu geordnete Schlüssel, geänderte Einrückungen und nachlaufende Kommas ergeben keine strukturellen Unterschiede, sodass nur Änderungen in den tatsächlichen Werten und Schlüsseln angezeigt werden. Verwenden Sie es, wenn beide Seiten gültig sind JSON; Zurück auf Text diff, wenn sie nicht sind.

Wie ignoriere ich Leerzeichen oder Fall beim Vergleich von Text?

Entscheiden Sie zuerst, ob Whitespace Rauschen oder Signal ist: im neu formatierten Code ist es Rauschen, aber in YAML oder Python-Einrückung ist es Struktur Wenn es Rauschen ist, normalisieren Sie beide Seiten, bevor Sie diffundieren - brechen Sie wiederholte Leerzeichen zusammen, streifen Sie nachlaufende Leerzeichen und machen Sie Zeilenenden konsistent - so bleiben nur echte Änderungen übrig Um den Fall zu ignorieren, senken Sie beide Texte vor dem Vergleich, da der Diff README und readme standardmäßig als unterschiedlich behandelt.

Welchen Algorithmus verwendet Git Diff?

Standardmäßig verwendet git diff eine Variante des Myers-Algorithmus, den gleichen Ansatz mit der längsten gemeinsamen Folge von Eugene Myers' 1986-Artikel, den die meisten Diff-Tools teilen. Git bietet auch Geduld und Histogrammvarianten, die Änderungen lesbarer gruppieren können, aber sie berichten über den gleichen Satz von Unterschieden - nur die Präsentationsänderungen. Dieses Tool verwendet dieselbe Myers-Algorithmusfamilie.