yamllint — online w chmurze

PROGRAM:

IMIĘ

yamllint -

Linter dla plików YAML.

yamllint nie tylko sprawdza poprawność składni, ale także dziwactwa, takie jak powtarzanie klawiszy
oraz problemy kosmetyczne, takie jak długość linii, spacje końcowe, wcięcia itp.

ZRZUT EKRANU

[zdjęcie: zrzut ekranu yamllint] [zdjęcie]

UWAGA:
Domyślny format wyjściowy jest inspirowany przez eslinta, świetne narzędzie do lintingu dla JavaScript.

STÓL JADALNIANY OF SPIS TREŚCI

Szybki start
Instalacja yamlint
W Fedorze / CentOS:

sudo dnf zainstaluj yamllint

W Debianie 9+ / Ubuntu 16.04+:

sudo apt-get zainstaluj yamllint

W starszych wersjach Debiana / Ubuntu:

sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
sudo apt-get zainstaluj yamllint

Alternatywnie używając pip, menedżera pakietów Pythona:

sudo pip zainstaluj yamllint

Jeśli wolisz instalować ze źródła, możesz uruchomić z katalogu źródłowego:

python setup.py sdist
sudo pip zainstaluj dist/yamllint-*.tar.gz

Bieganie yamlint
Podstawowe zastosowanie:

yamllint plik.yml inny plik.yaml

Możesz także lintować wszystkie pliki YAML w całym katalogu:

yamlint.

Dane wyjściowe będą wyglądać następująco (kolory nie są tutaj wyświetlane):

plik.yml
Spacje końcowe błędu 1:4 (spacje końcowe)
Błąd 4:4 nieprawidłowe wcięcie: oczekiwano 4, ale znaleziono 3 (wcięcie)
Duplikacja błędu 5:4 klucza „id-00042” w mapowaniu (duplikaty kluczy)
Komentarz ostrzegawczy 6:6 nie jest wcięty jak treść (wcięcie komentarzy)
Błąd 12:6 za dużo spacji po myślniku (łączniki)
15:12 błąd za dużo spacji przed przecinkiem (przecinek)

inny plik.yaml
Ostrzeżenie 1:1 brak początku dokumentu „---” (początek dokumentu)
Zbyt długa linia błędu 6:81 (87 > 80 znaków) (długość linii)
Błąd 10:1 za dużo pustych linii (4 > 2) (puste linie)
Błąd 11:4 za dużo spacji w nawiasach klamrowych (nawiasach klamrowych)

Dodaj -f analizowalny argumenty, jeśli potrzebujesz formatu wyjściowego przetwarzalnego przez maszynę (np
przykład dla składnia podświetlanie in XNUMX redaktorzy). Dane wyjściowe będą wyglądać następująco:

file.yml:6:2: [ostrzeżenie] brak początkowej spacji w komentarzu (komentarze)
file.yml:57:1: [błąd] końcowe spacje (końcowe spacje)
file.yml:60:3: [błąd] błędne wcięcie: oczekiwano 4, ale znaleziono 2 (wcięcie)

Jeśli masz niestandardowy plik konfiguracyjny lintingu (patrz w jaki sposób do skonfigurować yamlint), to może być
przekazany do yamllint za pomocą -c opcja:

yamllint -c ~/mojakonfiguracja plik.yaml

UWAGA:
Jeśli masz .yamllint plik w katalogu roboczym, zostanie on automatycznie załadowany
jako konfiguracja przez yamllint.

systemu
yamllint używa zestawu reguły aby sprawdzić pliki źródłowe pod kątem problemów. Każda reguła jest niezależna
od innych i można je włączać, wyłączać lub dostosowywać. Wszystkie te ustawienia mogą być
zebrane w pliku konfiguracyjnym.

Aby użyć niestandardowego pliku konfiguracyjnego, nadaj mu nazwę .yamllint w katalogu roboczym lub
użyć -c opcja:

yamllint -c ~/mojakonfiguracja plik.yaml

Domyślnie konfiguracja
O ile nie powiedziano inaczej, yamllint używa swojego domyślnym konfiguracja:

---

zasady:
aparat ortodontyczny:
min-spacje-wewnątrz: 0
max-spaces-wewnątrz: 0
nawiasy:
min-spacje-wewnątrz: 0
max-spaces-wewnątrz: 0
dwukropki:
max-spacje-przed: 0
maksymalne odstępy po: 1
przecinki:
max-spacje-przed: 0
min-spacje-po: 1
maksymalne odstępy po: 1
komentarze:
poziom: ostrzeżenie
wymagaj miejsca startowego: tak
minimalne przestrzenie z treści: 2
wcięcie komentarzy:
poziom: ostrzeżenie
koniec dokumentu: wyłącz
początek dokumentu:
poziom: ostrzeżenie
obecny: tak
puste wiersze:
maks.: 2
maksymalny start: 0
maksymalny koniec: 0
Myślniki:
maksymalne odstępy po: 1
wcięcie:
spacje: spójne
sekwencje wcięć: tak
check-multi-line-strings: nie
duplikaty kluczy: włącz
długość linii:
maks.: 80
Zezwól na niezniszczalne słowa: tak
nowa-linia-na-końcu-pliku: włącz
nowe wiersze:
typ: unix
końcowe spacje: włącz

Szczegóły dotyczące zasad znajdują się na stronie dotychczasowy reguły strona.

Istnieje inna wstępnie zdefiniowana konfiguracja o nazwie zrelaksowany. Jak sama nazwa wskazuje, jest czymś więcej
tolerancyjny.

Można go wybrać za pomocą:

yamllint -d zrelaksowany plik.yml

Rozsuwalny dotychczasowy domyślnym konfiguracja
Podczas pisania niestandardowego pliku konfiguracyjnego nie trzeba ponownie definiować każdej reguły. Tylko
przedłużyć domyślnym konfiguracji (lub dowolnego już istniejącego pliku konfiguracyjnego).

Na przykład, jeśli chcesz po prostu wyłączyć wcięcia komentarzy reguły, Twój plik może
wygląda jak to:

# To jest mój pierwszy, bardzo własny plik konfiguracyjny dla yamllint!
# Rozszerza domyślną konfigurację, dostosowując niektóre opcje.

rozciąga się: domyślnie

zasady:
wcięcia komentarzy: wyłącz # nie zawracaj mi głowy tą regułą

Podobnie, jeśli chcesz ustawić długość linii rządzić jako ostrzeżenie i być mniej surowym
wcięcia sekwencji bloków:

rozciąga się: domyślnie

zasady:
# 80 znaków powinno wystarczyć, ale nie zawiedź, jeśli linia jest dłuższa
długość linii:
maks.: 80
poziom: ostrzeżenie

# zaakceptuj oba klucze:
# - przedmiot
#
# i klucz:
# - przedmiot
wcięcie:
sekwencje wcięć: cokolwiek

warunki indywidualne konfiguracja bez a config filet
Możliwe jest — choć nie jest to zalecane — przekazanie niestandardowych opcji konfiguracyjnych do
yamllint z -d (skrót od --dane-konfiguracji) opcja.

Jego treścią może być nazwa predefiniowanej konfiguracji (przykład: domyślnym or zrelaksowany) lub
serializowany obiekt YAML opisujący konfigurację.

Na przykład:

yamllint -d "{rozszerza: zrelaksowany, reguły: {długość linii: {maks.: 120}}}" file.yaml

Błędy oraz ostrzeżenia
Problemy wykryte przez yamllint mogą być zgłaszane jako błędy lub ostrzeżenia.

W obu przypadkach skrypt wyświetli je (w różnych kolorach przy użyciu formatu
format wyjściowy), ale kod wyjścia może być inny. Dokładniej, skrypt zakończy działanie
będzie kod błędu tylko jeśli chodzi o komunikację i motywację występuje jeden lub więcej błędów.

Zasady
Podczas łączenia dokumentu za pomocą yamllint, szereg zasad (takich jak długość linii,
końcowe spacje, itp.) są sprawdzane.

A konfiguracja filet może służyć do włączania lub wyłączania tych reguł, do ustawiania ich poziomu
(błąd or ostrzeżenie), ale także dostosować ich opcje.

Ta strona opisuje zasady i ich opcje.

Lista of reguły
· szelki

· Wsporniki

· dwukropki

· przecinki

· komentarze

· wcięcia komentarzy

· koniec dokumentu

· początek dokumentu

· puste wiersze

· Myślniki

· wcięcie

· duplikaty kluczy

· długość linii

· nowa-wiersz-na-końcu-pliku

· nowe linie

· końcowe spacje

szelki
Użyj tej reguły, aby kontrolować liczbę spacji w nawiasach klamrowych ({ oraz }). Opcje.WKRĘT 0.0

· min-spacje-wewnątrz określa minimalną liczbę wymaganych spacji w nawiasach klamrowych.

· max-spaces-wewnątrz określa maksymalną liczbę spacji dozwolonych w nawiasach klamrowych.
1. Z aparat ortodontyczny: {min-spaces-wewnątrz: 0, max-spacje-wewnątrz: 0}

następujący fragment kodu by PASS:

obiekt: {klucz1:4, klucz2:8}

następujący fragment kodu by FAIL:

obiekt: {klucz1:4, klucz2:8}

2. Z aparat ortodontyczny: {min-spaces-wewnątrz: 1, max-spacje-wewnątrz: 3}

następujący fragment kodu by PASS:

obiekt: {klucz1:4, klucz2:8}

następujący fragment kodu by PASS:

obiekt: {klucz1:4, klucz2:8}

następujący fragment kodu by FAIL:

obiekt: {klucz1:4, klucz2:8}

następujący fragment kodu by FAIL:

obiekt: {klucz1:4, klucz2:8}

Wsporniki
Użyj tej reguły, aby kontrolować liczbę spacji w nawiasach ([ oraz ]). Opcje.INDENT
0.0

· min-spacje-wewnątrz określa minimalną liczbę wymaganych spacji w nawiasach.

· max-spaces-wewnątrz określa maksymalną liczbę spacji dozwolonych w nawiasach.
1. Z nawiasy: {min-spaces-wewnątrz: 0, max-spacje-wewnątrz: 0}

następujący fragment kodu by PASS:

obiekt: [1, 2, abc]

następujący fragment kodu by FAIL:

przedmiot: [ 1, 2, abc ]

2. Z nawiasy: {min-spaces-wewnątrz: 1, max-spacje-wewnątrz: 3}

następujący fragment kodu by PASS:

przedmiot: [ 1, 2, abc ]

następujący fragment kodu by PASS:

przedmiot: [ 1, 2, abc ]

następujący fragment kodu by FAIL:

przedmiot: [ 1, 2, abc ]

następujący fragment kodu by FAIL:

obiekt: [1, 2, abc ]

dwukropki
Użyj tej reguły, aby kontrolować liczbę spacji przed i po dwukropkach (:). Opcje.INDENT
0.0

· max-spacje-przed określa maksymalną liczbę spacji dozwolonych przed dwukropkami (use -1 do
wyłączyć).

· max-spacje-po określa maksymalną liczbę spacji dozwolonych po dwukropkach (use -1 do
wyłączyć).
1. Z dwukropki: {max-spaces-przed: 0, max-spacje-po: 1}

następujący fragment kodu by PASS:

obiekt:
-
- B
kluczowa wartość

2. Z dwukropki: {max-spaces-przed: 1}

następujący fragment kodu by PASS:

obiekt :
-
- B

następujący fragment kodu by FAIL:

obiekt :
-
- B

3. Z dwukropki: {max-spacje-po: 2}

następujący fragment kodu by PASS:

pierwszy: 1
drugie: 2
trzeci: 3

następujący fragment kodu by FAIL:

pierwszy: 1
2 miejsce: 2 XNUMX
trzeci: 3

przecinki
Użyj tej reguły, aby kontrolować liczbę spacji przed i po przecinkach (,). Opcje.INDENT
0.0

· max-spacje-przed określa maksymalną liczbę spacji dozwolonych przed przecinkami (use -1 do
wyłączyć).

· min-spacje-po określa minimalną liczbę wymaganych spacji po przecinkach.

· max-spacje-po określa maksymalną liczbę spacji dozwolonych po przecinkach (use -1 do
wyłączyć).
1. Z przecinki: {max-spaces-przed: 0}

następujący fragment kodu by PASS:

dziwna odmiana:
[10, 20, 30, {x: 1, y: 2}]

następujący fragment kodu by FAIL:

dziwna odmiana:
[10, 20, 30, {x: 1, y: 2}]

2. Z przecinki: {max-spaces-przed: 2}

następujący fragment kodu by PASS:

dziwna odmiana:
[10, 20, 30, {x: 1, y: 2}]

3. Z przecinki: {max-spaces-przed: -1}

następujący fragment kodu by PASS:

dziwna odmiana:
[10,
20, 30
, {x: 1, y: 2}]

4. Z przecinki: {min-spacje-po: 1, max-spacje-po: 1}

następujący fragment kodu by PASS:

dziwna odmiana:
[10, 20,30, {x: 1, y: 2}]

następujący fragment kodu by FAIL:

dziwna odmiana:
[10, 20,30, {x: 1, y: 2}]

5. Z przecinki: {min-spacje-po: 1, max-spacje-po: 3}

następujący fragment kodu by PASS:

dziwna odmiana:
[10, 20, 30, {x: 1, y: 2}]

6. Z przecinki: {min-spacje-po: 0, max-spacje-po: 1}

następujący fragment kodu by PASS:

dziwna odmiana:
[10, 20,30, {x: 1, y: 2}]

komentarze
Użyj tej reguły, aby kontrolować położenie i formatowanie komentarzy. Opcje.INDENT 0.0

· Posługiwać się wymagają-początkowej przestrzeni wymagać znaku spacji zaraz po #. Ustawić tak do
włączać, Nie wyłączyć.

· min-spacje-z-zawartości służy do wizualnego oddzielenia komentarzy wbudowanych od treści. To
określa minimalną wymaganą liczbę spacji między komentarzem a jego poprzednikiem
treści.
1. Z komentarze: {require-start-space: Tak}

następujący fragment kodu by PASS:

# To zdanie
# to komentarz blokowy

następujący fragment kodu by FAIL:

#To zdanie
# jest komentarzem blokowym

2. Z komentarze: {min-spaces-from-content: 2}

następujący fragment kodu by PASS:

x = 2 ^ 127 - 1 # Liczba pierwsza Mersenne'a

następujący fragment kodu by FAIL:

x = 2 ^ 127 - 1 # Liczba pierwsza Mersenne'a

wcięcia komentarzy
Użyj tej reguły, aby wymusić wcięcie komentarzy jak treść. Przykłady.INDENT 0.0

1. Z wcięcie komentarzy: {}

następujący fragment kodu by PASS:

# Fibonacciego
[0, 1, 1, 2, 3, 5]

następujący fragment kodu by FAIL:

# Fibonacciego
[0, 1, 1, 2, 3, 5]

następujący fragment kodu by PASS:

lista:
- 2
- 3
# - 4
- 5

następujący fragment kodu by FAIL:

lista:
- 2
- 3
# - 4
- 5

następujący fragment kodu by PASS:

# To jest pierwszy obiekt
przedmiot1:
- pozycja A
# - pozycja B
# To jest drugi obiekt
przedmiot2: []

następujący fragment kodu by PASS:

# To zdanie
# to komentarz blokowy

następujący fragment kodu by FAIL:

# To zdanie
# to komentarz blokowy

koniec dokumentu
Użyj tej reguły, aby wymagać lub zabronić używania znacznika końca dokumentu (...). Opcje.INDENT
0.0

· Ustawić teraźniejszość do tak kiedy wymagany jest znacznik końca dokumentu, lub do Nie kiedy to jest
zabroniony.
1. Z koniec dokumentu: {obecny: Tak}

następujący fragment kodu by PASS:

---
to:
jest: [a, dokument]
...
---
- to
- jest: inny
...

następujący fragment kodu by FAIL:

---
to:
jest: [a, dokument]
---
- to
- jest: inny
...

2. Z koniec dokumentu: {obecny: NIE}

następujący fragment kodu by PASS:

---
to:
jest: [a, dokument]
---
- to
- jest: inny

następujący fragment kodu by FAIL:

---
to:
jest: [a, dokument]
...
---
- to
- jest: inny

początek dokumentu
Użyj tej reguły, aby wymagać lub zabronić używania znacznika początku dokumentu (---). Opcje.INDENT
0.0

· Ustawić teraźniejszość do tak kiedy wymagany jest znacznik początku dokumentu, lub do Nie kiedy to jest
zabroniony.
1. Z początek dokumentu: {obecny: Tak}

następujący fragment kodu by PASS:

---
to:
jest: [a, dokument]
---
- to
- jest: inny

następujący fragment kodu by FAIL:

to:
jest: [a, dokument]
---
- to
- jest: inny

2. Z początek dokumentu: {obecny: NIE}

następujący fragment kodu by PASS:

to:
jest: [a, dokument]
...

następujący fragment kodu by FAIL:

---
to:
jest: [a, dokument]
...

puste wiersze
Użyj tej reguły, aby ustawić maksymalną liczbę dozwolonych kolejnych pustych linii. Opcje.INDENT
0.0

· max określa maksymalną liczbę pustych linii dozwolonych w dokumencie.

· maksymalny start określa maksymalną liczbę pustych linii dozwolonych na początku
plik. Ta opcja ma pierwszeństwo max.

· maksymalny koniec określa maksymalną liczbę pustych linii na końcu pliku. Ten
opcja ma pierwszeństwo przed max.
1. Z puste wiersze: {maks.: 1}

następujący fragment kodu by PASS:

- bla:
- 1
- 2

- słupek: [3, 4]

następujący fragment kodu by FAIL:

- bla:
- 1
- 2

- słupek: [3, 4]

Myślniki
Użyj tej reguły, aby kontrolować liczbę spacji po myślnikach (-). Opcje.WKRĘT 0.0

· max-spacje-po określa maksymalną liczbę spacji dozwolonych po myślnikach.
1. Z Myślniki: {max-spacje-po: 1}

następujący fragment kodu by PASS:

- pierwsza lista:
-
- B
- - 1
- 2
- 3

następujący fragment kodu by FAIL:

- pierwsza lista:
-
- B

następujący fragment kodu by FAIL:

- - 1
- 2
- 3

2. Z Myślniki: {max-spacje-po: 3}

następujący fragment kodu by PASS:

- klucz
- klucz2
- klucz42

następujący fragment kodu by FAIL:

- klucz
- klucz2
- klucz42

wcięcie
Użyj tej reguły, aby kontrolować wcięcia. Opcje.INDENT 0.0

· obowiązuje określa szerokość wcięcia w spacjach. Ustaw albo na liczbę całkowitą (np 2 or 4,
reprezentujący liczbę spacji na poziomie wcięcia) lub do zgodny pozwolić na jakiekolwiek
numer, o ile pozostaje on taki sam w pliku.

· sekwencje wcięć określa, czy sekwencje bloków powinny być wcięte, czy nie (jeśli w pliku a
mapowanie, to wcięcie nie jest obowiązkowe - niektórzy ludzie postrzegają - ramach
wcięcie). Możliwa wartość: tak, Nie, cokolwiek oraz zgodny. zgodny Wymaga
albo wszystkie sekwencje bloków mają być wcięte, albo żadne. cokolwiek oznacza albo
wcięcie lub brak wcięcia poszczególnych sekwencji bloków jest OK.

· sprawdź ciągi wielowierszowe określa, czy kłaść wcięcia w ciągach wielowierszowych. Ustawić
do tak umożliwić, Nie wyłączyć.
1. Z wcięcie: {spacje: 1}

następujący fragment kodu by PASS:

historia:
- nazwa: Unix
data: 1969
- nazwa: Linuks
data: 1991
gniazdo:
powtarzać się:
- stóg siana:
igła

2. Z wcięcie: {spacje: 4}

następujący fragment kodu by PASS:

historia:
- nazwa: Unix
data: 1969
- nazwa: Linuks
data: 1991
gniazdo:
powtarzać się:
- stóg siana:
igła

następujący fragment kodu by FAIL:

historia:
- nazwa: Unix
data: 1969
- nazwa: Linuks
data: 1991
gniazdo:
powtarzać się:
- stóg siana:
igła

3. Z wcięcie: {spacje: spójny}

następujący fragment kodu by PASS:

historia:
- nazwa: Unix
data: 1969
- nazwa: Linuks
data: 1991
gniazdo:
powtarzać się:
- stóg siana:
igła

następujący fragment kodu by FAIL:

Niektóre:
Rosyjski:
lalki

4. Z wcięcie: {spacje: 2, sekwencje wcięć: NIE}

następujący fragment kodu by PASS:

lista:
- latanie
- Spaghetti
- potwór

następujący fragment kodu by FAIL:

lista:
- latanie
- Spaghetti
- potwór

5. Z wcięcie: {spacje: 2, sekwencje wcięć: cokolwiek}

następujący fragment kodu by PASS:

lista:
- latanie:
- Spaghetti
- potwór
- nie latanie:
- Spaghetti
- sos

6. Z wcięcie: {spacje: 2, sekwencje wcięć: spójny}

następujący fragment kodu by PASS:

- latanie:
- Spaghetti
- potwór
- nie latanie:
- Spaghetti
- sos

następujący fragment kodu by FAIL:

- latanie:
- Spaghetti
- potwór
- nie latanie:
- Spaghetti
- sos

7. Z wcięcie: {spacje: 4, sprawdź ciągi wielowierszowe: Tak}

następujący fragment kodu by PASS:

Blaise Pascal:
Je vous écris une longue lettre parce que
je n'ai pas le temps d'en écrire une courte.

następujący fragment kodu by PASS:

Blaise Pascal: Je vous écris une longue lettre parce que
je n'ai pas le temps d'en écrire une courte.

następujący fragment kodu by FAIL:

Blaise Pascal: Je vous écris une longue lettre parce que
je n'ai pas le temps d'en écrire une courte.

następujący fragment kodu by FAIL:

kod C:
nieważna główna() {
printf("foo");
}

następujący fragment kodu by PASS:

kod C:
nieważna główna() {
printf("pasek");
}

duplikaty kluczy
Użyj tej reguły, aby zapobiec wielokrotnym wpisom z tym samym kluczem w mapowaniach. Przykłady.INDENT
0.0

1. Z duplikaty kluczy: {}

następujący fragment kodu by PASS:

- klawisz 1: w
klucz 2: wart
klucz 3: wartość
- {a: 1, b: 2, c: 3}

następujący fragment kodu by FAIL:

- klawisz 1: w
klucz 2: wart
klucz 1: wartość

następujący fragment kodu by FAIL:

- {a: 1, b: 2, b: 3}

następujący fragment kodu by FAIL:

duplikat klucza: 1
„duplikat klucza”: 2

inne powielanie: 1
? >-
Inne
powielanie
: 2

długość linii
Użyj tej reguły, aby ustawić limit długości linii. Opcje.WKRĘT 0.0

· max określa maksymalną (włączną) długość linii.

· zezwól na słowa-niezniszczalne służy do zezwalania na niełamliwe słowa (bez spacji w środku)
przekroczyć granicę. Jest to przydatne na przykład w przypadku długich adresów URL. Używać tak zezwolić, Nie
zakazać.
1. Z długość linii: {maks.: 70}

następujący fragment kodu by PASS:

długie zdanie:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua.

następujący fragment kodu by FAIL:

długie zdanie:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.

2. Z długość linii: {maks.: 60, zezwalaj na słowa-niezniszczalne: Tak}

następujący fragment kodu by PASS:

to:
jest:
- A:
http://localhost/very/very/very/very/very/very/very/very/long/url

# ten komentarz jest za długi,
# ale trudne do podzielenia:
# http://localhost/another/very/very/very/very/very/very/very/very/long/url

następujący fragment kodu by FAIL:

- ta linia jest baaaaaaaaaaaaaaaaaaaardzo długa, ale można ją łatwo podzielić...

3. Z długość linii: {maks.: 60, zezwalaj na słowa-niezniszczalne: NIE}

następujący fragment kodu by FAIL:

to:
jest:
- A:
http://localhost/very/very/very/very/very/very/very/very/long/url

nowa-wiersz-na-końcu-pliku
Użyj tej reguły, aby wymagać znaku nowego wiersza (\n) na końcu plików.

Standard POSIX Wymaga dotychczasowy trwać linia do zakończenia w a nowych linia charakter. Wszystkie UNIXy
narzędzia oczekują nowej linii na końcu plików. Większość edytorów tekstu również stosuje tę konwencję.

nowe linie
Użyj tej reguły, aby wymusić typ znaków nowego wiersza. Opcje.WKRĘT 0.0

· Ustawić rodzaj do UNIX używać znaków nowego wiersza typu UNIX (\n), lub dos używać nowego wpisanego w systemie DOS
znaki linii (\ R \ n).

końcowe spacje
Użyj tej reguły, aby zakazać końcowych spacji na końcu linii. Przykłady.INDENT 0.0

1. Z końcowe spacje: {}

następujący fragment kodu by PASS:

ten dokument nie zawiera
wszelkie spływy
obowiązuje

następujący fragment kodu by FAIL:

ten dokument zawiera
końcowe spacje
na liniach 1 i 3

oprogramowania
yamllint zapewnia zarówno skrypt, jak i moduł Pythona. Ten ostatni może być użyty do napisania twojego
własne narzędzia do strzępienia:

klasa yamllint.linter.LintProblem(linia, kolumna, desc=' opis>', reguła=brak)
Reprezentuje problem z lintingiem znaleziony przez yamllint.

kolumna = żaden
Kolumna, w której znaleziono problem (zaczynając od 1)

desc = żaden
Czytelny dla człowieka opis problemu

linia = żaden
Linia, w której znaleziono problem (zaczynając od 1)

rządzić = żaden
Identyfikator reguły, która wykryła problem

yamllint.linter.run (wejście, konf.)
Lints źródło YAML.

Zwraca generator obiektów LintProblem.

Parametry

· wkład -- bufor, ciąg znaków lub strumień do odczytu

· conf -- obiekt konfiguracyjny yamllint

CBCT w XNUMX redaktorzy
Większość edytorów tekstu obsługuje sprawdzanie i wyróżnianie składni w celu wizualnego raportowania składni
błędy i ostrzeżenia dla użytkownika. yamllint może służyć do sprawdzania składni źródła YAML, ale a
wymagana jest trochę konfiguracji w zależności od twojego ulubionego edytora tekstu.

Vim
Zakładając, że syntastyczny wtyczka jest zainstalowana, dodaj do swojego .vimrc:

niech g:syntastic_yaml_checkers = ['yamllint']

Neovimi
Zakładając, że neomake wtyczka jest zainstalowana, yamllint jest domyślnie obsługiwany. To jest
automatycznie włączane podczas edycji plików YAML.

Inne XNUMX redaktorzy
Potrzebna pomoc!

Twojego ulubionego edytora tekstu nie ma na liście? Pomóż nam ulepszyć, dodając sekcję (wg
otwarcie pull-request lub problemu w GitHub).

Korzystaj z yamllint online, korzystając z usług onworks.net