YAML tikrintuvas
Prieš diegimui ar CI procesui sutrikdant veikimą, patikrinkite YAML sintaksės klaidas. Tikrintuvas išanalizuoja kiekvieną įvesties dokumentą naudodamas YAML 1.2 analizatorių, atmeta pasikartojančius raktus, įtraukoms naudojamus tabuliacijos ženklus ir nekontroliuojamą slapyvardžių plėtimą, o apie pirmąją klaidą praneša nurodydamas dokumentą, eilutę ir stulpelį. Jei įvestis tinkama, pateikiamas dokumentų skaičius, kiekvieno jų aukščiausio lygio tipas ir visi įspėjimai. Skirta Kubernetes, Docker Compose ir konfigūracijos failų autoriams.
Dažnai užduodami klausimai
Ką tikrina YAML tikrintuvas?
Jis išanalizuoja visą YAML sintaksę: įtraukas, blokines ir srautines kolekcijas, kabutėmis apgaubtas ir paprastas skaliarines reikšmes, inkarus, slapyvardžius, žymas ir direktyvas. Pasikartojantys rakto ir reikšmės susiejimo raktai taip pat laikomi klaida. Pateikiamas patvirtinimas su trumpa santrauka arba nurodoma pirmosios klaidos vieta ir pateikiamas jos paaiškinimas.
Kokios YAML versijos laikomasi?
Validatorius naudoja YAML 1.2 pagrindinę schemą – naujausią specifikacijos versiją. Pagal 1.2, tokie žodžiai kaip yes, no, on ir off yra įprastos eilutės, o ne loginės reikšmės, todėl jie niekada nesukelia klaidos. Dokumentai, parengti YAML 1.1 įrankiams, vis tiek priimami, jei jų sintaksė taisyklinga.
Kodėl pasikartojantys raktai nurodomi kaip klaidos?
YAML specifikacijoje reikalaujama, kad susiejimo raktai būtų unikalūs. Daugelis analizatorių tyliai palieka paskutinę reikšmę, todėl paslepiamos konfigūracijos klaidos, pavyzdžiui, du kartus apibrėžtas nustatymas. Validatorius nurodo pasikartojančio rakto eilutę ir stulpelį, kad galėtumėte nuspręsti, kurią reikšmę palikti.
Kaip skaičiuojami eilučių, stulpelių ir dokumentų numeriai?
Eilutės ir stulpeliai pradedami skaičiuoti nuo 1 įvesties, kurią įklijuojate, pradžios. Dokumentai skaičiuojami jų pateikimo tvarka ir atskiriami eilutėmis su ---, todėl pirmasis dokumentas yra dokumentas 1. Pozicija nurodo vietą, kurioje analizatorius aptiko problemą, kuri gali būti iškart po tikrosios klaidos.
Ar galiu vienu metu patikrinti kelis YAML dokumentus?
Taip. Atskirkite dokumentus --- žymekliu, kaip kelių dokumentų Kubernetes manifeste, ir bus išanalizuotas kiekvienas dokumentas. Jei viskas taisyklinga, pateikiamas dokumentų skaičius ir kiekvieno jų aukščiausio lygio tipas.
Ką reiškia aukščiausio lygio tipas?
Jis nurodo, kas yra kiekvieno dokumento šaknyje: raktų ir reikšmių susiejimas, elementų seka, viena skaliarinė reikšmė arba nieko. Dauguma konfigūracijos failų yra susiejimai, o išteklių sąrašai dažnai yra sekos. Netinkamas tipas paprastai reiškia, kad brūkšnelis arba įtrauka įrašyti ne vietoje.
Kas yra įspėjimai?
Įspėjimai nurodo problemas, kurios nesustabdo analizės, pavyzdžiui, analizatoriui nežinomą žymą, kuri tada nuskaitoma kaip paprasta reikšmė. Kiekvienas įspėjimas pateikiamas su eilute ir stulpeliu; iš viso rodoma iki 20 įspėjimų. Dokumentas su įspėjimais vis tiek laikomas galiojančiu.
Kodėl tabuliacijos ženklai nepriimami?
YAML draudžia naudoti tabuliacijos ženklus įtraukai, nes jų plotis nėra aiškus. Pakeiskite nurodytos eilutės pradžioje esančius tabuliacijos ženklus tarpais ir išlaikykite tokią pačią įtrauką kaip aplinkinėse eilutėse. Tabuliacijos ženklai reikšmėse ir kabutėse pateiktose eilutėse leidžiami.
Ar įrankis apsaugotas nuo slapyvardžių bombų?
Taip. Slapyvardžiai gali būti išskleisti daugiausia 100 kartų, todėl dokumentas, sukurtas slapyvardžiams padauginti iki gigabaitų duomenų ir dažnai vadinamas „milijardo juoko“ ataka, nurodomas kaip netaisyklingas, užuot išeikvojus atmintį. Įprastai naudojant inkarus ir slapyvardžius bendriems nustatymams, ši riba nepasiekiama.
Ar tikrinama pagal tokią schemą kaip Kubernetes arba OpenAPI?
Ne, tikrinama tik sintaksė ir struktūra, o ne tai, ar raktai ir reikšmės atitinka konkrečią schemą. Įvesties dydis gali siekti 5 MiB. Norėdami galiojantį YAML konvertuoti į JSON, TOML arba kitą formatą, naudokite duomenų formatų keitiklį.