Проверка текстового дифференциала: перестаньте смотреть изменения, которые вы на самом деле не видите

Клиент WP Adminify однажды прислал мне два экспорта своих настроек плагина - & quot;до обновления все работало; после, меню администратора сломано. больше ничего не изменилось. & quot; Две капли JSON, каждая около 340 строк. я прочитал их рядом, дважды, и уверенно согласился с ним: идентично. ничего не изменилось. Должно быть, это наша ошибка.

Это было не было. Когда я, наконец, перестал доверять своим глазам и разбросал два файла, это было в строке 217: отключился ролевая клавиша меню. "administrator" на "administrator "- с конечным пространством. Один невидимый персонаж. Я лично читал мимо него дважды, потому что человеческие глаза don't сравнивают струны; они моделируют-соответствуют формам, и administrator а administrator имеют ту же форму.

Этот билет поддержки навсегда изменил мое правило: Если два текста длиннее, чем десять строк, я не сравниваю их, читая. когда-либо Алгоритм diff не имеет сочетающихся с шаблоном ярлыков, которые можно обмануть - он сравнивает каждый символ и точно сообщает, что отличается The Инструмент текстового дифференциала На Toolz.dev это делает в вашем браузере, что означает, что конфигурация клиентов, контракты и неизданный код никогда не покидают вашу машину. Вот как на самом деле работает diffing и как его правильно использовать.

TL;DR: Никогда визуально не сравнивайте тексты длиннее нескольких строк - глаза пропускают конечные пробелы, меняют местами цифры и редактируют одно слово. Вставьте обе версии в Инструмент текстового дифференциала: зеленый = добавлен, красный = удален, вычисляется тем же семейством алгоритмов Майерса, который выдает git diff, йо- обычай Режим линейки Для кода и конфигов Режим слов Для прозы и контрактов. Для структурированных данных JSON диф сравнивается по смыслу, а не по тексту. Все работает на стороне клиента.

Как на самом деле работает алгоритм diff?

Основная идея: найти Самая длинная общая подпоследовательность (LCS) из двух текстов - самая длинная последовательность строк (или слов, или символов), которая появляется в обоих, в одном и том же порядке.Все в LCS - & quot;unchanged.& quot; Whatever's, оставшаяся в версии A, - это удаление; whatever's, оставшаяся в версии B, - это дополнение. A & quot;modified& quot; строка - это всего лишь удаление и дополнение, которые случайно находятся рядом друг с другом.

Стандартный способ вычисления этого эффективно исходит из статьи Юджина Майерса 1986 года, "Алгоритм O(ND) и его вариации", йо- Элегантная часть — это то, что гласит граница сложности: север размер входа, но демократ Является ли количество различий. Два почти идентичных текста почти мгновенно расходятся, независимо от того, насколько они длинны, потому что алгоритм и #39;s работают в масштабах с тем, насколько они различны, а не только с тем, насколько велики. Это & # 39;s почему различение двух 300-строчных конфигураций, отличающихся одной строкой, кажется мгновенным - алгоритм почти ничего не делает, а это именно та ситуация, когда ваши глаза выполняют большую часть работы и терпят неудачу.

Это же семейство алгоритмов является движком по умолчанию в git diff, Гну diff, и большинство инструментов сравнения, которые вы когда-либо использовали. (Гит также предлагает patience а histogram варианты, которые иногда производят более удобочитаемые группы одних и тех же изменений - стойкий Изменения одинаковые, презентация отличается.)

Одно важное неочевидное свойство: дифференциал не всегда уникален. Если вы добавите пустую строку между двумя существующими пустыми строками, «какая» пустая строка является действительно неоднозначной, и разные инструменты могут выделять разные. Оба ответа верны.

Разница в строке, слове или символе - в каком режиме когда?

Детализация, которую вы сравниваете, меняет то, для чего хороша результат. Неправильное ошибку — основная причина, по которой люди находят дифференцированный выход «шум».

Конкретный пример. Оригинал: The quick brown fox jumps over the lazy dog. Изменено: The quick red fox leaps over the lazy cat.

• Режим линейки помечает все предложение как измененное - точное, бесполезное.
• Режим слов ровно выделяются brown→red, jumps→leaps, dog→cat, йо-
• Режим персонажа здесь избыточно, но это единственный режим, который поймал бы admlnistrator против administrator, йо-

Правило большого пальца: Структурированный текст (одно осмысленное утверждение в строке) хочет линейный режим; потоковый текст хочет режима слова; режим персонажа — это увеличительное стекло, которое вы вытаскиваете, когда два других говорят «изменены» и вы не можете понять почему. Моя ошибка с задержкой пространства — это канонический случай с символьным режимом.

Когда автономный инструмент diff лучше, чем git?

git diff превосходный Для вещей, которые живут в одном репозитории, йо- Удивительная работа сравнения не имеет:

Поддержка билетов. Сценарий из моего вступления - две настройки экспортируются от клиента. Они' не находятся ни в каком репо. Вставьте оба в Инструмент текстового дифференциала И ответ появляется в секундах вместо двух неудачных прочитан.

Конфигурационный дрейф. Стажировка nginx config против производства nginx config. течение .env против резервной копии до того, как все сломалось. git diff Не видит файлы на двух разных серверах, копи-вставка может.

Проверка формата. Вы пробежали красивее (или PHPCS, или черный) по файлу и хотите доказать, что он изменился Только форматирование, йо- Различие до и после: если вы видите что-то, кроме пробелов, кавычек и точек с запятой, форматтер прикасался к логике, и вы хотите знать сейчас.

Два ответа API. Стадирование возвращает одно тело JSON, производство возвращает другое, а интерфейс ломается только в постановке. Различайте ответы. (в частности, для JSON отдать предпочтение JSON диф- он сравнивает проанализированную структуру, поэтому порядок ключей и пробелы don't создают ложные срабатывания. Проведите обе полезные нагрузки через Форматтер JSON Сначала, если вам нужен читаемый текст diff вместо этого.)

документы и договоры. Поставщик возвращает & quot; тот же контракт с незначительными updates. & quot; Word-mode diff - это то, как вы обнаруживаете, что условия оплаты перешли от Net 30 к Net 15 в 40-страничном документе Редакторы и юристы знали это вечно - они называют это черной линией или красной линией.

Файлы перевода и локализации. Сравнение двух версий .po файл, чтобы увидеть, какие строки действительно изменились, прежде чем отправить его обратно переводчикам - реальный рабочий процесс WP Adminify, который экономит оплату за повторную трансляцию 400 неизмененных строк.

Общая нить: в тот момент, когда обе версии существуют в виде текста, который вы можете выбрать, инструмент различий отвечает & quot; что изменилось? & quot; механически. и потому, что инструмент Toolz.dev является клиентской, вставляя конфигурацию клиента & #39;s или неподписанный контракт dons& #39;t передает его куда угодно - тот же аргумент, что и остальная часть Конфиденциальность-первый набор инструментов, йо-

Как вы читаете вывод diff, не обманывая себя?

Соглашение о цвете универсально: Красный — это эксклюзивный контент старой версии (удален), зеленый — новая версия (добавлена), неизмененный текст отображается просто для контекста. Измененная линия отображается как красная линия, за которой следует зеленая замена.

Три привычки, которые делают Diff Review на самом деле надежной:

Поместите версии в правильные слоты. Старый/оригинал слева (или первое поле), новый/измененный справа. Поменяйте местами их, и каждое дополнение будет читаться как удаление - I' десять минут наблюдали, как люди отлаживают неправильное направление из-за этого. Если вывод выглядит назад, то, вероятно, так оно и есть.

Решите, что такое шум, прежде чем начать. Сравнение переформатированного кода? изменения пробелов - это шум - нормализуйте или игнорируйте их. Сравнивая конфигурации YAML? Пробел есть смысл- отступ - это структура в YAML, поэтому подтвердите обе стороны в Валидатор YAML и относиться к каждому пространству как к сигналу. Тот же инструмент, противоположные политики, и выбор неправильного либо закапывает реальную смену шума, либо скрывает его.

Читайте все куски, а не только первый. Запасным местом клиента и #39;s было изменение №1 из 1. Но когда разница показывает четыре изменения и первое объясняет ваш симптом, искушение прекратить чтение сильно - и изменение №3 иногда является тем, которое кусает вас на следующей неделе. разница уже сделала самое сложное; don't повторно ввести человеческую ошибку выборки на последнем этапе.

Что вам не может сказать текстовый разница?

Стоит честно сказать об ограничениях:

• Перемещенные блоки читаются как удаление + добавление. Вырежьте функцию сверху файла и вставьте ее внизу: дифференциал сообщает, что он удалил и добавил, не переместился. Некоторые специальные инструменты обнаруживают движения; обычные LCS не контролируются.
• Он сравнивает текст, а не смысл. 0.1 + 0.2 а 0.3 diff как разные (они есть), но и вести себя по-разному в плавающей запятой - и наоборот "key": 1 против "key": 1.0 Может быть текстуально разным, но семантически идентичным в вашем языке. структурированное сравнение (например, JSON диф) Закрывает часть этого пробела для форматов данных.
• Бинарный контент выходит за рамки. Изображения, PDF-файлы в виде байтов, исполняемые файлы - текст diff requireds text.Extract the text first, или используйте инструменты, специфичные для формата.
• Случай и кодировка сравниваются буквально. README ≠ readme, и цитата UTF-8 Curly ≠ Ascii Straight Quote, хотя они выглядят одинаково в большинстве шрифтов. (Еще одна ловушка для глаз, еще одна выигрыш для алгоритма.) предварительно нормализовать конвертер Если дело не должно иметь значения для вашего сравнения.

Часто задаваемые вопросы

Могу ли я сравнить файлы или только вставленный текст?

выше Инструмент текстового дифференциала работает над вставленным текстом: откройте каждый файл в любом редакторе, скопируйте, вставьте обе стороны.Это делает его не зависящим от формата - все, что 's читаемый текст (код, конфигурация, CSV, SQL, проза) можно сравнивать, независимо от расширения.

Есть ли ограничение по размеру для сравнения?

Практический предел — это память вашего устройства, так как обработка является встроенной в браузер. Файлы с несколькими тысячами строк сравниваются мгновенно; алгоритм Майерса масштабируется с количеством разногласия, поэтому даже большие, но похожие тексты остаются быстрыми. Сотни тысяч строк с огромными различиями могут занять несколько секунд.

Какой режим diff я должен использовать для кода?

Режим строки. код, естественно, представляет собой одно утверждение на строку, поэтому вывод на уровне строки четко отображается на то, как вы думаете об изменении. Переключитесь в режим слова или символа только тогда, когда строка помечена как измененная, и вы можете 't обнаружить разницу внутри нее - это 's обычно пробелы, цитаты или один символ.

Какой режим лучше всего подходит для контрактов и прозы?

Режим слова. изменения прозы обычно представляют собой замены слов и вставленные предложения внутри длинных абзацев; режим строки помечает целые абзацы и оставляет вас на охоте. выделение на уровне слова показывает, какие именно слова изменились - тот же подход, что и юридическая черная линия.

Диффефизирует или хранит мой текст?

нет Выделение существует только в отображаемом выходе; ваш входной текст не изменяется, и, поскольку инструмент работает полностью на стороне клиента, ни одна из версий не передается и нигде не сохраняется. Закройте вкладку, и тексты исчезнут.

Почему дифференциал выделяет линию, которая выглядит одинаково?

Почти всегда невидимые символы: трейлинг-пространства, вкладки против пробелов, окна \r\n против unix \n окончания строк, неразрывные пробелы или двойники Юникода (курчавые или прямые кавычки). Это именно тот класс изменений, которые человеческие глаза не видят, и алгоритмы различий всегда улавливают - мой билет поддержки конечного пространства был одним из них.

Может ли он обнаружить перемещенный текст?

Не как ход. стандартное LCS-основанное диффинг сообщает о перемещенном блоке как удаленном из старого местоположения и добавленном в новом. если вы подозреваете ход, выполните поиск по & quot;added& quot; текст в оригинале - точное попадание в другое место файла подтверждает это.

Чем JSON Diff отличается от текстового diff?

Текстовый дифференциал сравнивает символы; JSON диф Оба анализируют и сравнивают структуру. Переупорядоченные ключи, измененный отступ и конечные запятые не создают никаких структурных различий, поэтому вы видите только изменения фактических значений и ключей. Используйте его всякий раз, когда обе стороны действительны json; отступите к текстовому дифференциату, когда они не действительны.

Как игнорировать пробел или регистр при сравнении текста?

Сначала решите, является ли пробелы шумом или сигналом: в переформатированном коде это шум, но в YAML или Python отступом это структура Когда это шум, нормализуйте обе стороны перед различием - сверните повторяющиеся пробелы, полоскайте конечные пробелы и сделайте последовательными окончания строк - так что остаются только реальные изменения. Чтобы игнорировать падеж, строчные оба текста перед сравнением, поскольку diff рассматривает README и readme как разные по умолчанию.

Какой алгоритм использует git diff?

По умолчанию git diff использует вариант алгоритма Майерса, тот же самый длинный-общий-последовательный подход от Юджина Майерса ' 1986 статья, которую разделяют большинство инструментов diff.Git также предлагает терпение и варианты гистограммы, которые могут группировать изменения более читабельно, но они сообщают о том же наборе различий - изменяется только представление. этот инструмент использует то же семейство алгоритмов Майерса.