Co sprawdza walidator YAML?

YAML to format używany w wielu plikach konfiguracyjnych: plikach Docker Compose, manifestach Kubernetes, przepływach pracy GitHub Actions i GitLab CI, playbookach Ansible, specyfikacjach OpenAPI oraz ustawieniach niezliczonych aplikacji. Ponieważ w YAML wcięcia mają znaczenie, brak spacji, przypadkowy tabulator lub powtórzony klucz mogą zepsuć plik w sposób trudny do zauważenia. Walidator odczytuje YAML tak jak parser i wyświetla każdy problem wraz z numerem wiersza i kolumny.

Jak z niego korzystać

  1. Wklej lub wpisz YAML w edytorze.
  2. Wynik pojawia się podczas pisania: informacja, czy YAML jest poprawny, wraz z liczbą zawartych w nim dokumentów, albo lista wszystkich problemów w kolejności ich występowania w tekście.
  3. Każdy problem jest oznaczony w edytorze: błędy na czerwono, a ostrzeżenia na żółto. Kliknij problem, aby przewinąć edytor do odpowiedniego miejsca, lub kliknij oznaczenie, aby znaleźć go na liście.

Co wykrywa

  • Błędy składni: niedomknięte cudzysłowy i nawiasy, elementy z wcięciem zbyt małym lub zbyt dużym, klucz i element listy na tym samym poziomie, mapowania zagnieżdżone w jednym wierszu, takie jak a: b: c.
  • Powtórzone klucze: ten sam klucz występuje dwukrotnie w jednym mapowaniu. Większość parserów po cichu zachowałaby tylko jedną z wartości, przez co drugie ustawienie zostałoby utracone.
  • Tabulatory użyte jako wcięcia: YAML dopuszcza do wcięć tylko spacje.
  • Aliasy bez kotwic: alias *name wymaga wcześniejszej kotwicy &name w tym samym dokumencie.
  • Ostrzeżenia dotyczące elementów, które można sparsować, ale mogą nie działać zgodnie z zamierzeniem, takich jak nieznacznik znany parserowi lub nieobsługiwana wersja %YAML.

Ten sam klucz w różnych mapowaniach jest dozwolony. Dozwolony jest również plik zawierający kilka dokumentów oddzielonych przez ---: wiersze są liczone w całym pliku.

Czego nie sprawdza

Walidator sprawdza, czy tekst jest poprawnym YAML, a nie to, czy akceptuje go konkretny program. Plik Docker Compose może być poprawnym YAML, a mimo to zawierać ustawienie, którego Docker Compose nie rozpoznaje. Komunikaty pochodzą z biblioteki yaml i są wyświetlane po angielsku.

Jak działa

Narzędzie parsuje tekst za pomocą biblioteki yaml, która jest zgodna ze specyfikacją YAML 1.2 i wymaga unikatowych kluczy. Wszystko działa w przeglądarce: pliki nigdy nie są przesyłane.

Funkcje

  • Błędy składni z numerami wierszy i kolumn
  • Powtórzone klucze, tabulatory użyte jako wcięcia i aliasy bez kotwic
  • Błędy i ostrzeżenia oznaczone w edytorze; kliknij, aby przewinąć do odpowiedniego miejsca
  • Pliki zawierające kilka dokumentów
  • Działa w przeglądarce