yamllint - Bulutta Çevrimiçi

Program:

ADI

yallint -

YAML dosyaları için bir linter.

yamllint yalnızca sözdiziminin geçerliliğini değil, aynı zamanda anahtar tekrarı gibi tuhaflıkları da kontrol eder.
ve çizgi uzunluğu, sondaki boşluklar, girinti vb. gibi kozmetik sorunlar.

SCREENSHOT

[image: yamllint ekran görüntüsü] [image]

NOT:
Varsayılan çıktı formatı esinlenmiştir Eslint, Javascript için harika bir linting aracı.

TABLO OF İÇİNDEKİLER

Hızlı başlangıç
Takma yamlint
Fedora / CentOS'ta:

sudo dnf yamllint'i kurun

Debian 9+ / Ubuntu 16.04+ üzerinde:

sudo apt-get yükleme yamllint

Daha eski Debian/Ubuntu sürümlerinde:

sudo add-apt-deposu -y ppa:adrienverge/ppa && sudo apt-get güncellemesi
sudo apt-get yükleme yamllint

Alternatif olarak, Python paket yöneticisi pip kullanarak:

sudo pip yükleme yamllint

Kaynaktan yüklemeyi tercih ederseniz, kaynak dizinden çalıştırabilirsiniz:

piton setup.py sdist
sudo pip kurulum dist/yamllint-*.tar.gz

Koşu yamlint
Temel kullanım:

yamllint dosyası.yml other-file.yaml

Ayrıca bir dizindeki tüm YAML dosyalarını da lintleyebilirsiniz:

yamllint.

Çıktı şöyle görünecektir (renkler burada gösterilmez):

dosya.yml
1:4 hata sonundaki boşluklar (sondaki boşluklar)
4:4 hatası yanlış girinti: 4 bekleniyor ancak 3 bulundu (girinti)
Eşlemede "id-5" anahtarının 4:00042 hata çoğaltması (anahtar kopyaları)
6:6 uyarı yorumu, içerik gibi girintili değil (yorum girintisi)
12:6 hatası kısa çizgiden sonra çok fazla boşluk (tire)
15:12 hatası virgülden önce çok fazla boşluk (virgül)

diğer dosya.yaml
1:1 uyarı eksik belge başlangıcı "---" (belge başlangıcı)
6:81 hata satırı çok uzun (87 > 80 karakter) (satır uzunluğu)
10:1 hata çok fazla boş satır (4 > 2) (boş satır)
11:4 hatası parantezler (parantezler) içinde çok fazla boşluk var

Eklemek -f ayrıştırılamaz bir makine tarafından ayrıştırılabilen bir çıktı formatına ihtiyacınız varsa argümanlar (için
için örnek sözdizimi vurgulayarak in metin editörler). Çıktı daha sonra şöyle görünecektir:

file.yml:6:2: [uyarı] yorumda başlangıç ​​alanı eksik (yorumlar)
file.yml:57:1: [hata] sondaki boşluklar (sondaki boşluklar)
file.yml:60:3: [hata] yanlış girinti: 4 bekleniyor ama 2 bulundu (girinti)

Özel bir linting yapılandırma dosyanız varsa (bkz. Nasıl için yapılandırmak yamlint), olabilir
kullanılarak yamllint'e iletildi -c seçenek:

yamlint -c ~/yapılandırmam dosya.yaml

NOT:
Bir varsa .yamllint çalışma dizininizdeki dosya, otomatik olarak yüklenecektir.
yamllint tarafından yapılandırma olarak.

yapılandırma
yamllint bir dizi kullanır kurallar Kaynak dosyalarında sorun olup olmadığını kontrol etmek için. Her kural bağımsızdır
diğerlerinden ve etkinleştirilebilir, devre dışı bırakılabilir veya ince ayar yapılabilir. Tüm bu ayarlar olabilir
bir yapılandırma dosyasında toplanmıştır.

Özel bir yapılandırma dosyası kullanmak için onu adlandırın .yamllint çalışma dizininizde veya
kullan -c seçenek:

yamlint -c ~/yapılandırmam dosya.yaml

Varsayılan yapılandırma
Aksi söylenmedikçe, yamllint varsayılan yapılandırma:

---

kurallar:
ayraçları:
min-boşluk-iç: 0
max-space-inside: 0
parantez:
min-boşluk-iç: 0
max-space-inside: 0
iki nokta üst üste:
maksimum boşluk-önce: 0
max-boşluk-sonrası: 1
virgül:
maksimum boşluk-önce: 0
min-boşluk-sonrası: 1
max-boşluk-sonrası: 1
yorumlar:
seviye: uyarı
başlangıç ​​alanı gerektirir: evet
içerikten minimum boşluk: 2
yorumlar girintisi:
seviye: uyarı
belge sonu: devre dışı bırak
belge başlangıcı:
seviye: uyarı
mevcut: evet
boş satırlar:
maksimum: 2
maksimum başlangıç: 0
maksimum uç: 0
kısa çizgiler:
max-boşluk-sonrası: 1
girinti:
boşluklar: tutarlı
girinti dizileri: evet
çok satırlı dizileri kontrol et: hayır
anahtar kopyaları: etkinleştir
satır uzunluğu:
maksimum: 80
kırılmaz-kelimelere izin ver: evet
dosya sonunda yeni satır: etkinleştir
yeni satırlar:
tür: unix
sondaki boşluklar: etkinleştir

Kurallarla ilgili ayrıntılar şurada bulunabilir: the kurallar Kanal.

adlı başka bir önceden tanımlanmış yapılandırma var. rahat. Adından da anlaşılacağı gibi, daha çok
hoşgörülü.

Aşağıdakiler kullanılarak seçilebilir:

yamllint -d rahat dosya.yml

uzatma the varsayılan yapılandırma
Özel bir yapılandırma dosyası yazarken, her kuralı yeniden tanımlamanız gerekmez. Sadece
uzatmak varsayılan yapılandırma (veya zaten var olan herhangi bir yapılandırma dosyası).

Örneğin, yalnızca devre dışı bırakmak istiyorsanız yorumlar girintisi kural, dosyanız
şuna benzer:

# Bu benim yamllint için ilk, çok özel yapılandırma dosyam!
# Bazı seçenekleri ayarlayarak varsayılan conf'u genişletir.

uzanır: varsayılan

kurallar:
yorum girintisi: devre dışı bırak # bu kuralla beni rahatsız etme

Benzer şekilde, ayarlamak istiyorsanız satır uzunluğu bir uyarı olarak kural ve daha az katı olmak
blok dizileri girintisi:

uzanır: varsayılan

kurallar:
# 80 karakter yeterli olmalı, ancak bir satır daha uzunsa başarısız olmayın
satır uzunluğu:
maksimum: 80
seviye: uyarı

# her iki anahtarı da kabul et:
# - kalem
#
# ve anahtar:
# - kalem
girinti:
girinti dizileri: her neyse

görenek yapılandırma olmadan a yapılandırma dosya
Önerilmemesine rağmen, özel yapılandırma seçeneklerini şu adrese iletmek mümkündür:
ile yamllint -d (için kısa --config-veri) seçeneği.

İçeriği, önceden tanımlanmış bir conf adı olabilir (örnek: varsayılan or rahat) Veya
yapılandırmayı açıklayan serileştirilmiş bir YAML nesnesi.

Örneğin:

yamllint -d "{genişler: gevşemiş, kurallar: {satır uzunluğu: {maks: 120}}}" file.yaml

Hatalar ve uyarılar
yamllint tarafından tespit edilen sorunlar, hata veya uyarı olarak ortaya çıkabilir.

Her iki durumda da, komut dosyası bunları çıkaracaktır (kullanırken farklı renklerle). standart
çıktı biçimi), ancak çıkış kodu farklı olabilir. Daha doğrusu, komut dosyası çıkacak
hata kodu olacak bir tek ne zaman bir veya daha fazla hata var.

Kurallar
Bir belgeyi yamllint ile çizerken, bir dizi kural (ör. satır uzunluğu,
sondaki boşluklar, vb.) karşı kontrol edilir.

A yapılandırma dosya seviyelerini ayarlamak için bu kuralları etkinleştirmek veya devre dışı bırakmak için kullanılabilir
(hata or uyarı), aynı zamanda seçeneklerini değiştirmek için.

Bu sayfada kurallar ve seçenekleri açıklanmaktadır.

Liste of kurallar
· pantolon askısı

· parantez

· iki nokta üst üste

· virgül

· yorumlar

· yorumlar girintisi

· belge sonu

· belge başlangıcı

· boş satırlar

· tire

· girinti

· anahtar kopyaları

· satır uzunluğu

· dosya sonunda yeni satır

· yeni hatlar

· sondaki boşluklar

pantolon askısı
Parantez içindeki boşluk sayısını kontrol etmek için bu kuralı kullanın ({ ve }). Seçenekler.INDENT 0.0

· min-boşluk-inside parantezler içinde gereken minimum boşluk sayısını tanımlar.

· max-space-inside parantez içinde izin verilen maksimum boşluk sayısını tanımlar.
1. İle ayraçları: {min-boşluk-inside: 0, max-space-inside: 0}

aşağıdaki kod parçası PASS:

nesne: {key1: 4, key2: 8}

aşağıdaki kod parçası FAIL:

nesne: { key1: 4, key2: 8 }

2. İle ayraçları: {min-boşluk-inside: 1, max-space-inside: 3}

aşağıdaki kod parçası PASS:

nesne: { key1: 4, key2: 8 }

aşağıdaki kod parçası PASS:

nesne: { key1: 4, key2: 8 }

aşağıdaki kod parçası FAIL:

nesne: { key1: 4, key2: 8 }

aşağıdaki kod parçası FAIL:

nesne: {key1: 4, key2: 8 }

parantez
Parantez içindeki boşluk sayısını kontrol etmek için bu kuralı kullanın ([ ve ]). Seçenekler.GİRİNÇ
0.0

· min-boşluk-inside parantez içinde gereken minimum boşluk sayısını tanımlar.

· max-space-inside parantez içinde izin verilen maksimum boşluk sayısını tanımlar.
1. İle parantez: {min-boşluk-inside: 0, max-space-inside: 0}

aşağıdaki kod parçası PASS:

nesne: [1, 2, abc]

aşağıdaki kod parçası FAIL:

nesne: [ 1, 2, abc ]

2. İle parantez: {min-boşluk-inside: 1, max-space-inside: 3}

aşağıdaki kod parçası PASS:

nesne: [ 1, 2, abc ]

aşağıdaki kod parçası PASS:

nesne: [ 1, 2, abc ]

aşağıdaki kod parçası FAIL:

nesne: [ 1, 2, abc ]

aşağıdaki kod parçası FAIL:

nesne: [1, 2, abc ]

iki nokta üst üste
İki nokta üst üste işaretinden önceki ve sonraki boşluk sayısını kontrol etmek için bu kuralı kullanın (:). Seçenekler.GİRİNÇ
0.0

· max-boşluk-öncesi iki nokta üst üste işaretinden önce izin verilen maksimum boşluk sayısını tanımlar (kullanın -1 için
devre dışı bırakmak).

· max-boşluk-sonrası iki nokta üst üste işaretlerinden sonra izin verilen maksimum boşluk sayısını tanımlar (kullanım -1 için
devre dışı bırakmak).
1. İle iki nokta üst üste: {max-boşluk-öncesi: 0, max-boşluk-sonrası: 1}

aşağıdaki kod parçası PASS:

nesne:
- Bir
- b
anahtar: değer

2. İle iki nokta üst üste: {max-boşluk-öncesi: 1}

aşağıdaki kod parçası PASS:

nesne :
- Bir
- b

aşağıdaki kod parçası FAIL:

nesne :
- Bir
- b

3. İle iki nokta üst üste: {max-boşluk-sonrası: 2}

aşağıdaki kod parçası PASS:

ilk: 1
saniye: 2
üçüncü: 3

aşağıdaki kod parçası FAIL:

ilk: 1
2: 2
üçüncü: 3

virgül
Virgülden önceki ve sonraki boşluk sayısını kontrol etmek için bu kuralı kullanın (,). Seçenekler.GİRİNÇ
0.0

· max-boşluk-öncesi virgüllerden önce izin verilen maksimum boşluk sayısını tanımlar (kullanın -1 için
devre dışı bırakmak).

· min-boşluk-sonrası virgülden sonra gereken minimum boşluk sayısını tanımlar.

· max-boşluk-sonrası virgülden sonra izin verilen maksimum boşluk sayısını tanımlar (kullanım -1 için
devre dışı bırakmak).
1. İle virgül: {max-boşluk-öncesi: 0}

aşağıdaki kod parçası PASS:

garip var:
[10, 20, 30, {x: 1, y: 2}]

aşağıdaki kod parçası FAIL:

garip var:
[10, 20 , 30, {x: 1, y: 2}]

2. İle virgül: {max-boşluk-öncesi: 2}

aşağıdaki kod parçası PASS:

garip var:
[10 , 20 , 30, {x: 1 , y: 2}]

3. İle virgül: {max-boşluk-öncesi: -1}

aşağıdaki kod parçası PASS:

garip var:
[10,
20, 30
, {x: 1, y: 2}]

4. İle virgül: {min-boşluk-sonrası: 1, max-boşluk-sonrası: 1}

aşağıdaki kod parçası PASS:

garip var:
[10, 20,30, {x: 1, y: 2}]

aşağıdaki kod parçası FAIL:

garip var:
[10, 20,30, {x: 1, y: 2}]

5. İle virgül: {min-boşluk-sonrası: 1, max-boşluk-sonrası: 3}

aşağıdaki kod parçası PASS:

garip var:
[10, 20, 30, {x: 1, y: 2}]

6. İle virgül: {min-boşluk-sonrası: 0, max-boşluk-sonrası: 1}

aşağıdaki kod parçası PASS:

garip var:
[10, 20,30, {x: 1, y: 2}]

yorumlar
Yorumların konumunu ve biçimlendirmesini kontrol etmek için bu kuralı kullanın. Seçenekler.INDENT 0.0

· Kullanmak başlangıç-alanı gerektirir hemen sonra bir boşluk karakteri gerektirmek için #. Ayarlanır Evet için
etkinleştirme, yok hayır devre dışı bırakmak için.

· içerikten minimum boşluklar satır içi yorumları içerikten görsel olarak ayırmak için kullanılır. Bilişim Teknoloji
bir yorum ile bir önceki yorum arasında gerekli olan minimum boşluk sayısını tanımlar.
içeriği.
1. İle yorumlar: {require-start-space: Evet}

aşağıdaki kod parçası PASS:

# Bu cümle
# bir blok yorumdur

aşağıdaki kod parçası FAIL:

#Bu cümle
#bir blok yorumdur

2. İle yorumlar: {içerikten minimum alan: 2}

aşağıdaki kod parçası PASS:

x = 2 ^ 127 - 1 # Mersenne asal sayı

aşağıdaki kod parçası FAIL:

x = 2 ^ 127 - 1 # Mersenne asal sayı

yorumlar girintisi
Yorumları içerik gibi girintilenmeye zorlamak için bu kuralı kullanın. Örnekler.INDENT 0.0

1. İle yorumlar girintisi: {}

aşağıdaki kod parçası PASS:

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

aşağıdaki kod parçası FAIL:

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

aşağıdaki kod parçası PASS:

liste:
- 2
- 3
# - 4
- 5

aşağıdaki kod parçası FAIL:

liste:
- 2
- 3
# - 4
- 5

aşağıdaki kod parçası PASS:

# Bu ilk nesne
nesne1:
- öğe A
# - öğe B
# Bu ikinci nesne
nesne2: []

aşağıdaki kod parçası PASS:

# Bu cümle
# bir blok yorumdur

aşağıdaki kod parçası FAIL:

# Bu cümle
# bir blok yorumdur

belge sonu
Belge bitiş işaretinin kullanılmasını zorunlu kılmak veya yasaklamak için bu kuralı kullanın (Kendi ID’n ile mağazalarını oluştur). Seçenekler.GİRİNÇ
0.0

· Ayarlamak mevcut için Evet belge bitiş işareti gerektiğinde veya yok hayır ne zaman
yasaklı.
1. İle belge sonu: {sunmak: Evet}

aşağıdaki kod parçası PASS:

---
bu:
şudur: [a, belge]
Kendi ID’n ile mağazalarını oluştur
---
- bu
- şudur: başka biri
Kendi ID’n ile mağazalarını oluştur

aşağıdaki kod parçası FAIL:

---
bu:
şudur: [a, belge]
---
- bu
- şudur: başka biri
Kendi ID’n ile mağazalarını oluştur

2. İle belge sonu: {sunmak: numara}

aşağıdaki kod parçası PASS:

---
bu:
şudur: [a, belge]
---
- bu
- şudur: başka biri

aşağıdaki kod parçası FAIL:

---
bu:
şudur: [a, belge]
Kendi ID’n ile mağazalarını oluştur
---
- bu
- şudur: başka biri

belge başlangıcı
Belge başlangıç ​​işaretçisinin kullanılmasını zorunlu kılmak veya yasaklamak için bu kuralı kullanın (---). Seçenekler.GİRİNÇ
0.0

· Ayarlamak mevcut için Evet belge başlangıç ​​işaretçisi gerektiğinde veya yok hayır ne zaman
yasaklı.
1. İle belge başlangıcı: {sunmak: Evet}

aşağıdaki kod parçası PASS:

---
bu:
şudur: [a, belge]
---
- bu
- şudur: başka biri

aşağıdaki kod parçası FAIL:

bu:
şudur: [a, belge]
---
- bu
- şudur: başka biri

2. İle belge başlangıcı: {sunmak: numara}

aşağıdaki kod parçası PASS:

bu:
şudur: [a, belge]
Kendi ID’n ile mağazalarını oluştur

aşağıdaki kod parçası FAIL:

---
bu:
şudur: [a, belge]
Kendi ID’n ile mağazalarını oluştur

boş satırlar
İzin verilen maksimum ardışık boş satır sayısını ayarlamak için bu kuralı kullanın. Seçenekler.GİRİNÇ
0.0

· maksimum belgede izin verilen maksimum boş satır sayısını tanımlar.

· maksimum başlangıç başlangıcında izin verilen maksimum boş satır sayısını tanımlar.
dosya. Bu seçenek şuna göre önceliklidir: maksimum.

· maksimum son dosyanın sonunda izin verilen maksimum boş satır sayısını tanımlar. Bu
seçenek önceliklidir maksimum.
1. İle boş satırlar: {maks: 1}

aşağıdaki kod parçası PASS:

-foo:
- 1
- 2

- çubuk: [3, 4]

aşağıdaki kod parçası FAIL:

-foo:
- 1
- 2

- çubuk: [3, 4]

tire
Tireden sonraki boşluk sayısını kontrol etmek için bu kuralı kullanın (-). Seçenekler.INDENT 0.0

· max-boşluk-sonrası tirelerden sonra izin verilen maksimum boşluk sayısını tanımlar.
1. İle kısa çizgiler: {max-boşluk-sonrası: 1}

aşağıdaki kod parçası PASS:

- ilk liste:
- Bir
- b
- - 1
- 2
- 3

aşağıdaki kod parçası FAIL:

- ilk liste:
- Bir
- b

aşağıdaki kod parçası FAIL:

- - 1
- 2
- 3

2. İle kısa çizgiler: {max-boşluk-sonrası: 3}

aşağıdaki kod parçası PASS:

- anahtar
- anahtar2
- anahtar42

aşağıdaki kod parçası FAIL:

- anahtar
- anahtar2
- anahtar42

girinti
Girintiyi kontrol etmek için bu kuralı kullanın. Seçenekler.INDENT 0.0

· alanlarda boşluklarda girinti genişliğini tanımlar. İkisinden birini bir tam sayıya ayarlayın (örn. 2 or 4,
girinti düzeyindeki boşluk sayısını temsil eden) veya tutarlı herhangi birine izin vermek
sayı, dosya içinde aynı kaldığı sürece.

· girinti dizileri blok dizilerinin girintili olup olmayacağını tanımlar (bir
haritalama, bu girinti zorunlu değildir - bazı insanlar - bir parçası olarak
girinti). Olası değerler: Evet, yok hayır, ne ve tutarlı. tutarlı gerektirir
ya tüm blok dizileri girintili olacak ya da hiçbiri olmayacak. ne ya
bireysel blok dizilerinin girintilenmesi veya girintilenmemesi uygundur.

· çok satırlı dizeleri kontrol et çok satırlı dizelerde girintinin tüy bırakılıp bırakılmayacağını tanımlar. Ayarlamak
için Evet etkinleştirmek, yok hayır devre dışı bırakmak için.
1. İle girinti: {boşluklar: 1}

aşağıdaki kod parçası PASS:

Tarihçe:
- isim: Unix
tarih: 1969
- isim: Linux
tarih: 1991
yuva:
yineleme:
- samanlık:
iğne

2. İle girinti: {boşluklar: 4}

aşağıdaki kod parçası PASS:

Tarihçe:
- isim: Unix
tarih: 1969
- isim: Linux
tarih: 1991
yuva:
yineleme:
- samanlık:
iğne

aşağıdaki kod parçası FAIL:

Tarihçe:
- isim: Unix
tarih: 1969
- isim: Linux
tarih: 1991
yuva:
yineleme:
- samanlık:
iğne

3. İle girinti: {boşluklar: tutarlı}

aşağıdaki kod parçası PASS:

Tarihçe:
- isim: Unix
tarih: 1969
- isim: Linux
tarih: 1991
yuva:
yineleme:
- samanlık:
iğne

aşağıdaki kod parçası FAIL:

biraz:
Rusça:
oyuncak bebekler

4. İle girinti: {boşluklar: 2, girinti dizileri: numara}

aşağıdaki kod parçası PASS:

liste:
- uçan
- Spagetti
- canavar

aşağıdaki kod parçası FAIL:

liste:
- uçan
- Spagetti
- canavar

5. İle girinti: {boşluklar: 2, girinti dizileri: her neyse}

aşağıdaki kod parçası PASS:

liste:
- uçan:
- Spagetti
- canavar
- uçmamak:
- Spagetti
- Sos

6. İle girinti: {boşluklar: 2, girinti dizileri: tutarlı}

aşağıdaki kod parçası PASS:

- uçan:
- Spagetti
- canavar
- uçmamak:
- Spagetti
- Sos

aşağıdaki kod parçası FAIL:

- uçan:
- Spagetti
- canavar
- uçmamak:
- Spagetti
- Sos

7. İle girinti: {boşluklar: 4, çok satırlı dizeleri kontrol edin: Evet}

aşağıdaki kod parçası PASS:

Blaise Pascal:
Bir süre daha bekleyeceksin
en son günaydın.

aşağıdaki kod parçası PASS:

Blaise Pascal: İyi günler
en son günaydın.

aşağıdaki kod parçası FAIL:

Blaise Pascal: İyi günler
en son günaydın.

aşağıdaki kod parçası FAIL:

C kodu:
geçersiz ana() {
printf("foo");
}

aşağıdaki kod parçası PASS:

C kodu:
geçersiz ana() {
printf("çubuk");
}

anahtar kopyaları
Eşlemelerde aynı anahtarla birden çok girişi önlemek için bu kuralı kullanın. Örnekler.INDENT
0.0

1. İle anahtar kopyaları: {}

aşağıdaki kod parçası PASS:

- tuş 1: v
anahtar 2: val
anahtar 3: değer
- {a: 1, b: 2, c: 3}

aşağıdaki kod parçası FAIL:

- tuş 1: v
anahtar 2: val
anahtar 1: değer

aşağıdaki kod parçası FAIL:

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

aşağıdaki kod parçası FAIL:

yinelenen anahtar: 1
"yinelenen anahtar": 2

diğer çoğaltma: 1
? >-
Diğer
teksir
: 2

satır uzunluğu
Satır uzunluğuna bir sınır ayarlamak için bu kuralı kullanın. Seçenekler.INDENT 0.0

· maksimum çizgilerin maksimum (dahil) uzunluğunu tanımlar.

· izin-kırılmaz-kelimeler kırılmaz kelimelere izin vermek için kullanılır (içinde boşluk olmadan)
sınırı aşmak için. Bu, örneğin uzun URL'ler için kullanışlıdır. Kullanmak Evet izin vermek, yok hayır
yasaklamak.
1. İle satır uzunluğu: {maks: 70}

aşağıdaki kod parçası PASS:

uzun cümle:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut emek ve dolore magna aliqua.

aşağıdaki kod parçası FAIL:

uzun cümle:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
Tempor olayı ut emek ve dolore magna aliqua.

2. İle satır uzunluğu: {maks: 60, kırılmaz-kelimelere izin ver: Evet}

aşağıdaki kod parçası PASS:

bu:
olduğu:
- A:
http://localhost/very/very/very/very/very/very/very/very/long/url

# bu yorum çok uzun,
# ama ayırması zor:
# http://localhost/another/very/very/very/very/very/very/very/very/long/url

aşağıdaki kod parçası FAIL:

- bu satır waaaaaaaaaaaaaay çok uzun ama kolayca bölünebilir...

3. İle satır uzunluğu: {maks: 60, kırılmaz-kelimelere izin ver: numara}

aşağıdaki kod parçası FAIL:

bu:
olduğu:
- A:
http://localhost/very/very/very/very/very/very/very/very/long/url

dosya sonunda yeni satır
Yeni bir satır karakteri gerektirmek için bu kuralı kullanın (\n) dosyaların sonunda.

POSIX standardı gerektirir the son hat için son ile a yeni hat karakter. Tüm UNIX'ler
araçlar, dosyaların sonunda yeni bir satır bekler. Çoğu metin düzenleyici de bu kuralı kullanır.

yeni hatlar
Yeni satır karakterlerinin türünü zorlamak için bu kuralı kullanın. Seçenekler.INDENT 0.0

· Ayarlamak tip için unix UNIX tipi yeni satır karakterlerini kullanmak için (\n) veya içeride DOS tipi yeni kullanmak için
satır karakterleri (\ R \ n).

sondaki boşluklar
Satırların sonundaki boşlukları yasaklamak için bu kuralı kullanın. Örnekler.INDENT 0.0

1. İle sondaki boşluklar: {}

aşağıdaki kod parçası PASS:

bu belge içermiyor
herhangi bir takip
alanlarda

aşağıdaki kod parçası FAIL:

bu belge şunları içerir:
sondaki boşluklar
1. ve 3. satırlarda

gelişme
yamllint hem bir komut dosyası hem de bir Python modülü sağlar. İkincisi yazmak için kullanılabilir
kendi linting araçları:

sınıf yamllint.linter.LintProblem(satır, kolon, azalan =' açıklama>', kural=Yok)
yamllint tarafından bulunan bir tiftiklenme sorununu temsil eder.

sütun = Hayır
Sorunun bulunduğu sütun (1'den başlayarak)

Azalan = Hayır
Sorunun insan tarafından okunabilir açıklaması

hat = Hayır
Sorunun bulunduğu hat (1'den başlayarak)

kural = Hayır
Sorunu algılayan kuralın tanımlayıcısı

yamllint.linter.run(girdi, konf)
Bir YAML kaynağını lintler.

LintProblem nesnelerinin bir oluşturucusunu döndürür.

Parametreler

· giriş -- okunacak arabellek, dize veya akış

· conf -- yamllint yapılandırma nesnesi

Entegrasyonu ile metin editörler
Çoğu metin düzenleyici, sözdizimini görsel olarak bildirmek için sözdizimi denetimi ve vurgulamayı destekler
kullanıcıya yönelik hatalar ve uyarılar. yamllint, YAML kaynağının sözdizimini kontrol etmek için kullanılabilir, ancak
favori metin düzenleyicinize bağlı olarak biraz yapılandırma gereklidir.

Gayret
Farzedelim ki sözdizimsel eklenti yüklendi, ekleyin .vimrc:

let g:syntastic_yaml_checkers = ['yamllint']

neovim
Farzedelim ki neo-make eklenti kurulu, yamllint varsayılan olarak destekleniyor. Bu
YAML dosyalarını düzenlerken otomatik olarak etkinleştirilir.

Diğer metin editörler
Yardım isteniyor!

Favori metin düzenleyiciniz burada listelenmiyor mu? Bir bölüm ekleyerek iyileştirmemize yardımcı olun (
GitHub'da bir çekme isteği veya sorunu açma).

onworks.net hizmetlerini kullanarak yamllint'i çevrimiçi kullanın