Что проверяет валидатор YAML?

YAML — формат многих файлов конфигурации: файлов Docker Compose, манифестов Kubernetes, рабочих процессов GitHub Actions и GitLab CI, плейбуков Ansible, спецификаций OpenAPI и настроек бесчисленного множества приложений. Поскольку в YAML отступы несут смысловую нагрузку, пропущенный пробел, случайная табуляция или повторяющийся ключ могут нарушить работу файла так, что ошибку будет трудно заметить. Валидатор читает ваш YAML так же, как это делает парсер, и перечисляет все проблемы с указанием строки и столбца.

Как пользоваться

  1. Вставьте YAML в редактор или введите его вручную.
  2. Результат отображается по мере ввода: либо YAML корректен и указано количество документов в нём, либо все проблемы перечислены в порядке их появления в тексте.
  3. Каждая проблема отмечена в редакторе: ошибки — красным, предупреждения — жёлтым. Нажмите на проблему, чтобы прокрутить редактор до неё, или нажмите на отметку, чтобы найти её в списке.

Что обнаруживает

  • Синтаксические ошибки: незакрытые кавычки и скобки, недостаточный или чрезмерный отступ элементов, ключ и элемент списка на одном уровне, вложенные в одну строку отображения, например a: b: c.
  • Повторяющиеся ключи: один и тот же ключ дважды в одном отображении. Большинство парсеров молча оставили бы только одно из значений, из-за чего остальные настройки были бы потеряны.
  • Табуляции в отступах: YAML допускает в отступах только пробелы.
  • Псевдонимы без якорей: для псевдонима *name нужен якорь &name, расположенный выше в том же документе.
  • Предупреждения о конструкциях, которые разбираются, но могут работать не так, как задумано, например о неизвестном парсеру теге или неподдерживаемой версии %YAML.

Одинаковый ключ в разных отображениях — это нормально. Также допустим файл с несколькими документами, разделёнными строкой ---: номера строк отсчитываются по всему файлу.

Что не проверяет

Валидатор проверяет, что текст является корректным YAML, но не проверяет, принимает ли его конкретная программа. Файл Docker Compose может быть корректным YAML, но содержать параметр, неизвестный Docker Compose. Сообщения предоставляются библиотекой yaml на английском языке.

Как это работает

Инструмент разбирает текст с помощью библиотеки yaml, которая следует спецификации YAML 1.2 и требует, чтобы ключи были уникальными. Всё выполняется в вашем браузере: ваши файлы никогда не загружаются на сервер.

Возможности

  • Синтаксические ошибки с указанием строки и столбца
  • Повторяющиеся ключи, табуляции в отступах и псевдонимы без якорей
  • Ошибки и предупреждения отмечаются в редакторе; нажатие прокручивает его к нужному месту
  • Поддержка файлов с несколькими документами
  • Работает в вашем браузере