Mitä YAML-validaattori tarkistaa?

YAML on monien asetustiedostojen formaatti: Docker Compose -tiedostot, Kubernetes-manifestit, GitHub Actions- ja GitLab CI -työnkulut, Ansible-playbookit, OpenAPI-määritykset ja lukemattomien sovellusten asetukset. Koska sisennys vaikuttaa YAMLissa merkitykseen, puuttuva välilyönti, ylimääräinen sarkain tai toistuva avain voi rikkoa tiedoston tavalla, jota on vaikea huomata. Validaattori lukee YAMLiasi jäsentimen tavoin ja luettelee jokaisen ongelman riveineen ja sarakkeineen.

Käyttöohjeet

  1. Liitä tai kirjoita YAML-editoriin.
  2. Tulos näkyy kirjoittaessasi: joko YAML on kelvollinen ja mukana olevien dokumenttien määrä ilmoitetaan, tai kaikki ongelmat luetellaan tekstin mukaisessa järjestyksessä.
  3. Jokainen ongelma merkitään editoriin: virheet punaisella ja varoitukset keltaisella. Siirry ongelman kohdalle napsauttamalla sitä tai etsi ongelma luettelosta napsauttamalla merkintää.

Mitä se löytää

  • Syntaksivirheet: sulkemattomat lainausmerkit ja hakasulkeet, liian vähän tai liikaa sisennetyt kohdat, samalla tasolla sekoitetut avain ja luettelokohde sekä yhdelle riville sisäkkäin kirjoitetut määritykset, kuten a: b: c.
  • Toistuvat avaimet: sama avain kahdesti yhdessä määrityksessä. Useimmat jäsentimet säilyttäisivät hiljaisesti vain toisen arvoista, jolloin toinen asetus katoaisi.
  • Sisennyksessä käytetyt sarkaimet: YAML sallii sisennyksessä vain välilyönnit.
  • Aliakset ilman ankkureita: *name-alias edellyttää, että samassa dokumentissa on aiemmin määritetty &name-ankkuri.
  • Varoitukset sellaisista kohdista, jotka jäsentyvät mutta eivät ehkä toimi tarkoitetulla tavalla, kuten jäsentimelle tuntemattomasta tunnisteesta tai tuetusta %YAML-versiosta poikkeavasta versiosta.

Sama avain eri määrityksissä on sallittu, samoin tiedosto, jossa on useita ----erottimilla erotettuja dokumentteja: rivit lasketaan koko tiedostosta.

Mitä se ei tarkista

Validaattori tarkistaa, että teksti on kelvollista YAMLia, ei sitä, hyväksyykö jokin tietty ohjelma sen. Docker Compose -tiedosto voi olla kelvollista YAMLia, vaikka siinä olisi asetus, jota Docker Compose ei tunne. Viestit tulevat yaml-kirjastosta ja ovat englanniksi.

Toimintaperiaate

Työkalu jäsentää tekstin yaml-kirjastolla, joka noudattaa YAML 1.2 -määritystä ja edellyttää, että avaimet ovat yksilöllisiä. Kaikki suoritetaan selaimessasi: tiedostojasi ei koskaan ladata palvelimelle.

Ominaisuudet

  • Syntaksivirheet riveineen ja sarakkeineen
  • Toistuvat avaimet, sisennyksessä käytetyt sarkaimet ja aliakset ilman ankkureita
  • Virheet ja varoitukset merkitään editoriin, ja napsauttamalla siirryt niiden kohdalle
  • Tuki tiedostoille, joissa on useita dokumentteja
  • Toimii selaimessasi