YAML linter online: sprawdzaj składnię w trakcie pisania
Wklej swój YAML, a ten YAML linter online sprawdzi go w trakcie pisania i wyjaśni każdy problem ze składnią prostymi słowami, z wierszem i kolumną. Wyłapuje wcięcia zrobione tabulatorem, zdublowane klucze, niezamknięte cudzysłowy i nawiasy oraz niewidoczne spacje nierozdzielające, które wyglądają jak wcięcie, ale nim nie są. Twój YAML jest sprawdzany w twojej przeglądarce i nigdy nie jest wysyłany.
Jak użyć lintera YAML online krok po kroku
Wklej lub wpisz swój YAML w polu YAML. Nie ma przycisku sprawdzania: tekst jest sprawdzany na bieżąco.
- Wklejony tekst jest sprawdzany od razu. Gdy piszesz, sprawdzanie startuje około ćwierć sekundy po ostatnim klawiszu, przy bardzo dużym tekście trochę później. Poprzedni wynik pozostaje przyciemniony, aż pojawi się nowy.
- Przeczytaj ramkę pod edytorem. Zielona ramka Poprawny YAML oznacza, że składnia jest dobra. Czerwona ramka „Niepoprawny YAML” (albo „Niepoprawny YAML: N problemów”) wylicza, co jest nie tak.
- Każdy problem ma zdanie, „Wiersz N, kolumna M” i fragment wiersza z numerami wierszy: dwa wiersze wyżej, jeden niżej i znak ^ pod kolumną.
- Wybierz Pokaż w edytorze, aby zaznaczyć ten wiersz w polu. Popraw go i patrz, jak ramka robi się zielona.
Dla każdego dokumentu zgłaszany jest tylko pierwszy błąd składni. Kolejne to zwykle skutki uboczne, na przykład brakujący cudzysłów, który pochłania wiersze poniżej. Zdublowane klucze i niezdefiniowane aliasy są zawsze wypisywane wszystkie. Pokazanych jest do 20 problemów.
Yamllint online: najczęstsze problemy i ich naprawa
Szukasz yamllint online? Ten linter YAML online sprawdza tylko składnię. Każdy problem jest wyjaśniony jednym zdaniem zamiast surowego komunikatu parsera. Oto te, które zdarzają się najczęściej:
- Wiersz ma wcięcie zrobione tabulatorem. Edytor wstawił tabulator albo przyszedł razem z wklejonym tekstem. Zamień tabulator na spacje.
- Wiersz nie jest wyrównany z pozostałymi kluczami swojego mapowania. Jeden klucz ma o jedną spację więcej lub mniej niż sąsiedzi. Nadaj kluczom na tym samym poziomie takie samo wcięcie.
- Wcięcie jest błędne. Zagnieżdżony blok nie ma głębszego wcięcia niż jego rodzic. Wcięj element podrzędny głębiej niż klucz nadrzędny.
- Klucz występuje więcej niż raz w tym samym mapowaniu. Zwykle skopiowany blok zostawił powtórzony klucz. Połącz wpisy albo usuń duplikat.
- Wiersz nie jest parą klucz: wartość. Brakuje dwukropka albo zawinięty wiersz nie ma wcięcia. Dodaj
:po kluczu albo wcięj dalszy ciąg. - Jedna para jest zapisana wewnątrz innej w tym samym wierszu. Zwykle to drugi dwukropek w zwykłej wartości, jak w
a: b: c. Ujmij wartość w cudzysłów albo użyj nowego wiersza z wcięciem. - Nawias nigdy nie jest zamknięty albo cudzysłów się nie kończy. Komunikat wskazuje wiersz, w którym się zaczęły. Dodaj znak zamykający.
- Brakuje przecinka między elementami w
[ ]lub{ }. Dwa elementy się stykają. Dodaj przecinek. - Wartość zaczyna się od
@albo od grawisu. Ujmij ją w cudzysłów. - Znak
#przykleił się do poprzedniego słowa. Komentarz zaczyna się tylko po spacji. Dodaj spację albo ujmij tekst w cudzysłów. \qnie jest poprawną sekwencją ucieczki w podwójnym cudzysłowie. Zdarza się to w ścieżkach Windows. Zapisz\\albo użyj apostrofów.- Alias wskazuje kotwicę, która nie jest zdefiniowana wyżej. Zdefiniuj
&nazwawcześniej w pliku. - Ta część nie pasuje tutaj. Często lista z
-jest wymieszana z wierszamiklucz: wartośćna tym samym poziomie albo wiersz wyżej jest niedokończony. Umieść listę pod własnym kluczem i sprawdź wiersz wyżej. - Dyrektywa
%na początku dokumentu jest niepoprawna lub nieobsługiwana. Usuń ją albo użyj poprawnie%YAMLlub%TAG.
Co znaczą komunikaty innych parserów
Trafiasz tu z komunikatu w terminalu lub logu CI? Tak typowe sformułowania odpowiadają temu, co zgłasza ten linter. Wklej ten sam plik, a pokaże ci wiersz.
found character that cannot start any token while scanning for the next token: tabulator na początku wiersza albo wartość zaczynająca się od@lub grawisu.tabs are not allowed for indent: tabulator użyty jako wcięcie.mapping values are not allowed here: drugi dwukropek w jednym wierszu, jak wa: b: c, wartość bez cudzysłowu zawierająca:albo wiersz z wcięciem pod kluczem, który ma już wartość.did not find expected key: wiersz niewyrównany z pozostałymi kluczami swojego mapowania.bad indentation of a mapping entry: klucz z wcięciem na złej głębokości.could not find expected ':': wiersz bez dwukropka po kluczu.
Sformułowania różnią się między parserami (PyYAML, js-yaml, Ruby, Go, loadery Home Assistant i ESPHome), a parser często zgłasza wiersz poniżej prawdziwego błędu. Ten linter wskazuje wiersz, który może ci pokazać.
Tabulatory i niewidoczne znaki
Dwa najtrudniejsze do zauważenia błędy w YAML to te, których nie widać. Ten linter robi je widocznymi.
- Tabulator we fragmencie jest rysowany jako strzałka, a spacja nierozdzielająca lub o zerowej szerokości jako kropka.
- Jeśli wiersz z błędem zawiera niewidoczny znak, dodatkowy wiersz podaje jego nazwę z punktem kodowym, na przykład
U+00A0, i kolumnę. Obejmuje to spacje nierozdzielające, znaki o zerowej szerokości, znacznik kolejności bajtów i spacje pełnej szerokości. - Gdy plik jest poprawny, ale wiersz zaczyna się niewidoczną spacją, pod zieloną ramką pojawia się żółta ramka Poprawny, ale sprawdź ten wiersz. YAML czyta ten znak jako część klucza, więc wiersz naprawdę nie ma wcięcia. Zwykle pochodzi z tekstu skopiowanego ze strony internetowej, wiki albo komunikatora.
Przykład: w pliku z server: i poniżej port: 8080 ostatni wiersz, host: example.com, zaczyna się od dwóch spacji nierozdzielających zamiast dwóch zwykłych spacji. YAML czyta go jako osobny klucz najwyższego poziomu, a host nie jest dzieckiem server. Żółta ramka wskazuje znak i wiersz.
Formatuj YAML i kopiuj wynik
Włącz przełącznik Formatuj YAML nad polem. Domyślnie jest wyłączony. Gdy tekst jest poprawny, pojawia się blok Sformatowany YAML z przyciskiem Kopiuj nad nim, który po skopiowaniu zmienia się w Skopiowano. Formatowanie jest przewidywalne:
- Wcięcie to 2 spacje. Nie ma innej szerokości, a listy pod kluczem mają wcięcie.
- Komentarze, kotwice, aliasy, style cudzysłowów i kolejność kluczy są zachowane.
- Długie wiersze nigdy nie są zawijane.
- Kilka dokumentów zachowuje separatory
---.
Formatowany jest tylko poprawny YAML, więc nie naprawi zepsutego pliku: najpierw popraw błędy. Bardzo długie wyniki są pokazywane ucięte po 600 000 znaków, a Kopiuj nadal kopiuje wszystko.
Zastosowania, rozmiar i ograniczenia
Sprawdzanie jest takie samo, niezależnie od tego, do czego służy twój YAML. Działa na workflow GitHub Actions, docker-compose.yml, manifesty Kubernetes i wartości Helm, pliki OpenAPI, playbooki Ansible, konfigurację Home Assistant, szablony CloudFormation i konfigurację mkdocs. Wklej plik przed commitem, a błędy składni pojawią się bez czekania na przebieg CI. Plik z kilkoma dokumentami oddzielonymi --- jest sprawdzany dokument po dokumencie, a zielona ramka podaje, ile ich znalazła. Kotwice (&nazwa) i aliasy (*nazwa) są sprawdzane. Własne tagi, jak !Ref, !Sub i !GetAtt z CloudFormation czy !reference z GitLab, są uznawane za poprawne.
Sprawdzanie działa w Web Workerze w twojej przeglądarce. Typowe pliki konfiguracji, CI i Kubernetes są sprawdzane w mgnieniu oka. Limit to 5 000 000 znaków, a tekst bliski limitu zajmuje kilka sekund i dużo pamięci. Powyżej limitu zostaniesz poproszony o wklejenie mniejszego fragmentu.
Sprawdzana jest tylko składnia YAML. Narzędzie nie wie, czego oczekuje dany program, więc pola Kubernetes, klucze GitHub Actions czy Docker Compose i reguły JSON Schema nie są sprawdzane, a błędnie napisana nazwa klucza i tak przejdzie. Linter stosuje YAML 1.2, więc słowa yes, no, on i off z YAML 1.1 to zwykły tekst i nigdy nie są oceniane. Niczego nie uruchamia, nie pobiera i nie ładuje, a pojedynczy stary znak powrotu karetki z Maca nie jest traktowany jako koniec wiersza.
Pracujesz z innymi formatami? Uporządkuj i sprawdź JSON w narzędziu Formatowanie JSON, sprawdź go ze schematem w narzędziu Walidator JSON Schema albo sprawdź znaczniki w narzędziu Walidator XML. Szukasz wzorca w konfiguracji? Wypróbuj go w narzędziu Tester regex.
Najczęstsze pytania
Jak użyć lintera YAML online?
Wklej swój YAML w polu „YAML”. Tekst jest sprawdzany podczas wklejania i pisania, więc nie ma przycisku do naciśnięcia. Zielona ramka „Poprawny YAML” oznacza, że składnia jest dobra. Czerwona ramka „Niepoprawny YAML” podaje każdy problem prostymi słowami z „Wiersz N, kolumna M” i fragmentem wiersza.
Dlaczego YAML mówi, że tabulatory nie są dozwolone we wcięciach?
YAML dopuszcza we wcięciach tylko spacje, a tabulator na początku wiersza to błąd składni. Edytory często wstawiają tabulatory po naciśnięciu klawisza Tab albo tabulator przychodzi razem z wklejonym tekstem. Linter zgłasza, że wiersz ma wcięcie zrobione tabulatorem. Zamień tabulator na spacje.
Co znaczy „mapping values are not allowed here” w YAML?
Zwykle w wierszu jest drugi dwukropek, jak w „a: b: c”, albo wartość bez cudzysłowu zawiera dwukropek. Może to też być wiersz z wcięciem pod kluczem, który ma już wartość. Ujmij wartość w cudzysłów albo zapisz wewnętrzną parę w osobnym wierszu z wcięciem.
Co znaczy „did not find expected key” w YAML?
Wiersz nie jest wyrównany z pozostałymi kluczami swojego mapowania. Zwykle jeden klucz ma o jedną spację więcej lub mniej niż sąsiedzi. Nadaj wszystkim kluczom na tym samym poziomie takie samo wcięcie. Linter zgłasza to jako wiersz niewyrównany z innymi kluczami.
Jak znaleźć zdublowane klucze w YAML?
Wklej tekst. Zdublowane klucze w tym samym mapowaniu są zawsze wypisywane wszystkie, każdy z wierszem i kolumną. Zwykle skopiowany blok zostawił powtórzony klucz. Połącz wpisy albo usuń duplikat.
Dlaczego poprawny plik pokazuje „Poprawny, ale sprawdź ten wiersz”?
Wiersz zaczyna się niewidoczną spacją, na przykład spacją nierozdzielającą. YAML czyta ją jako część klucza, więc wiersz naprawdę nie ma wcięcia, choć plik jest poprawny. Żółta ramka wskazuje znak i wiersz. Usuń go i wpisz zwykłe spacje.
Czy mogę tu sprawdzić plik YAML dla GitHub Actions, Docker Compose lub Kubernetes?
Tak, sprawdzanie składni jest takie samo dla każdego YAML. Działa na workflow, docker-compose.yml, manifesty Kubernetes i wiele innych plików. Sprawdzana jest tylko składnia: linter nie wie, jakich kluczy oczekuje dany program, a błędnie napisana nazwa klucza i tak przejdzie.
Jak duży może być plik YAML?
Limit to 5 000 000 znaków. Typowe pliki konfiguracji są sprawdzane w mgnieniu oka, a tekst bliski limitu zajmuje kilka sekund i dużo pamięci. Powyżej limitu zostaniesz poproszony o wklejenie mniejszego fragmentu.
Polecane
-
Yubico Security Key C NFCZabezpiecz konto GitHub lub chmury, do którego wypychasz tę konfigurację.
-
Elgato Stream Deck Neo (8 klawiszy)Jeden klawisz do twoich poleceń lint, commit i deploy.
-
Inteligentne listwy świetlne GoveeMiękkie światło za ekranem na nocne poprawki pipeline'u.
Pomaga utrzymać narzędzia za darmo. ✨
Zdjęcia poglądowe. Jestem Partnerem Amazon i otrzymuję wynagrodzenie z tytułu określonych zakupów dokonywanych za moim pośrednictwem.