RegexSmith

Зачем RegexSmith

Возможности

• Карточка при наведении на шаблон в C#: шаблон с цветными группами, по строке на каждую часть простыми словами, цветные метки групп и статус — ✓ безопасно, ⚠ может зависнуть или ✕ недопустимо.
• Подчёркивание групп: тонкая линия цвета группы под каждой захватывающей группой прямо в коде; вложенные группы — ниже.
• Примеры, составленные по шаблону, — две подходящие строки и одна неподходящая, — проверенные настоящим движком .NET.
• RX001: волнистая линия под повторениями, которые могут занять экспоненциальное время, с исправлениями в Ctrl+. и предпросмотром «до/после».
• Тестер RegexSmith, закреплённый рядом с окном «Результаты поиска»: ваши примеры с ожиданиями ✓/✗, подсвеченные совпадения и группы, таблица групп и вкладка Замена.
• Применить к коду: изменённый шаблон возвращается в строковый литерал того же вида вместе с параметрами — одним действием отмены.
• Копировать как модульный тест для xUnit, NUnit или MSTest — ваши примеры становятся тестовыми случаями.

Карточка при наведении

Наведите курсор на строку шаблона — и в обычной подсказке Visual Studio появится карточка RegexSmith: что означает шаблон, чему он соответствует и безопасен ли он.

Где это работает

В файлах C#, над шаблоном в:

• new Regex("…"), с RegexOptions или без;
• статических методах Regex.IsMatch, Match, Matches, Replace, Split и Count;
• [GeneratedRegex("…")];
• [RegularExpression("…")] — тогда карточка пишет Проверка: должно совпасть всё значение;
• const string в том же файле, которую использует один из них.

Обычные, буквальные (@"…") и необработанные ("""…""") строки читаются так же, как их читает компилятор, поэтому "\\d" и @"\d" — один и тот же шаблон.

Что показывает карточка

Статус

«Безопасно» означает только это: .NET принимает шаблон, и он не может зависнуть. Это не значит, что он совпадает с тем, что вы задумали, — для этого и нужны примеры и тестер.

Подчёркивание групп

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

Группа внутри другой группы расположена чуть ниже, так что видны обе линии. Цвета идут по порядку: лососевый, зелёный, синий, фиолетовый, янтарный, бирюзовый — и снова по кругу.

Подчёркивание можно выключить в настройках: Подчёркивать группы захвата.

Шаблоны, которые могут зависнуть

Некоторые шаблоны работают экспоненциальное время на длинной строке, которая почти совпадает, — классический способ, которым регулярное выражение подвешивает веб-запрос. RegexSmith находит их по форме и ставит волнистую линию предупреждения под повторением; наведите на неё курсор, чтобы узнать причину.

Что подчёркивается (RX001)

• Вложенное повторение: (a+)+, ([a-z0-9]+\.?)+ — одну последовательность одинаковых символов можно разделить между внутренним и внешним повторением огромным числом способов.
• Повторение альтернатив, совпадающих с одними и теми же символами: (\w|\d)+ — цифру может взять любая ветвь, поэтому каждая цифра удваивает работу.

Не внутри атомарных групп и проверок окружения и никогда с RegexOptions.NonBacktracking — там это невозможно.

Исправления в Ctrl+.

Поставьте курсор на волнистую линию и нажмите Ctrl+. — каждое исправление показывает предпросмотр: шаблон до (зачёркнутый) и после.

RX001 можно выключить в настройках (Подсказки в редакторе) или ссылкой Не показывать такие подсказки во всплывающей подсказке; исправления в Ctrl+. остаются.

Тестер

Тестер RegexSmith открывается закреплённым рядом с окном «Результаты поиска». Шаблон берётся из кода и остаётся связанным с ним: проверьте его на своих примерах, измените и запишите обратно.

Как открыть

• ▶ Проверить шаблон… в карточке при наведении;
• Ctrl+. на шаблоне › Проверить этот шаблон в RegexSmith;
• щелчок правой кнопкой в файле C# › Проверить шаблон регулярного выражения;
• Вид › Другие окна › Тестер RegexSmith — без связи с кодом: место, чтобы попробовать шаблон.

Шаблон и его параметры

Вверху — файл и строка шаблона; щёлкните, чтобы перейти туда. Ниже — поле шаблона, строка статуса (✓ безопасно, ⚠ может зависнуть или ошибка движка, затем N из M как ожидалось · мс) и кнопки параметров: IgnoreCase, Multiline, Singleline, IgnorePatternWhitespace, ExplicitCapture, RightToLeft, CultureInvariant. Любое изменение сразу запускает проверку заново.

Примеры и ожидания

В первый раз там уже есть примеры из карточки: два, которые должны совпасть, и один, который не должен. Введите новый в поле Добавьте пример и нажмите Enter…; щёлкните пример, чтобы изменить его, ✕ удаляет его. Значок перед каждым примером говорит, что он должен делать, — щёлкните его, чтобы поменять:

Пример, который ведёт себя наоборот, становится красным — ✗ совпадает или ✗ не совпадает, — так примеры превращаются в маленькую спецификацию шаблона. Совпадения подкрашены, группы подчёркнуты своими цветами, пробелы показаны точками. Проверка, которая длится больше 1 секунды, останавливается с пометкой ⏱ слишком медленно.

Группы выбранного примера перечисляет все совпадения выбранного примера: сначала всё совпадение, затем каждую группу с её значением и позицией (не захвачена, если группа не участвовала).

Замена

Вкладка Замена добавляет поле замены — $1, ${name}, $$ для $ — и показывает результат для каждого примера так, как это сделал бы Regex.Replace.

Копировать, вернуть, применить

Копировать как модульный тест помещает в буфер обмена тест с вашими примерами для xUnit, NUnit или MSTest — спецификация переезжает в тестовый проект.

Вернуть восстанавливает шаблон и параметры из кода; примеры остаются.

Применить к коду записывает шаблон обратно литералом того же вида, каким он был (обычным, буквальным или необработанным), вместе с параметрами — одна отмена возвращает всё назад. Если этот код изменился после того, как тестер его открыл, ничего не записывается: откройте тестер из шаблона заново.

Примеры запоминаются для каждого шаблона и каждого решения в %LocalAppData%\RegexSmith\samples, так что в следующий раз они уже на месте. В репозиторий ничего не попадает.

Настройки

Средства › Параметры › SmithWorks › RegexSmith. У каждого параметра есть краткое описание того, что он делает.

Параметр	По умолчанию
Объяснять шаблоны при наведении	вкл.
Подчёркивать группы захвата	вкл.
RX001 Катастрофический бэктрекинг	вкл.
Попросить оценку в Marketplace	вкл.

Внизу: Сбросить по умолчанию, Документация, Оценить на Marketplace и Обратная связь.

Настройки хранятся в %LocalAppData%\RegexSmith.

Вопросы и ответы

История изменений

1.0.1

• У подсказок в редакторе свой список на странице параметров, а ссылка во всплывающей подсказке отключает вид подсказок прямо там, где вы его видите.

1.0.0

• Первый выпуск: карточка при наведении с разбором простыми словами, цветными группами, примерами, проверенными движком .NET, и статусом; подчёркивание групп в коде; RX001 для шаблонов, которые могут зависнуть, с исправлениями через атомарную группу и NonBacktracking в Ctrl+.; Тестер RegexSmith с ожиданиями, группами, вкладкой «Замена», кнопками «Копировать как модульный тест» и «Применить к коду»; однократная просьба об оценке.