Főbb pontok
- 01A YAML-t konzisztens behúzással formázza a js-yaml elemző használatával — ugyanaz a könyvtár, amelyet a Node.js buildjében használnak.
- 02Validálja a szintaxist, és pontosan hibasorokat jelent meg.
- 03A YAML és JSON közötti konvertálás mindkét irányban helyes típus megőrzéssel.
- 04Semmi sem kerül feltöltésre — az egész művelet helyileg a böngészőben fut.
Miért számít a YAML formázása a konfigurációs fájlokhoz
A YAML a Kubernetes, GitHub Actions, Docker Compose, Helm diagramok és sok más eszköz alapértelmezett konfigurációs nyelve. Ez is híresen bizalmas a behúzáshoz — egy egyetlen hibásan behúzott sor csendes típus eltérést vagy kemény elemzési hibát okozhat, amely blokkolja a telepítést. A rendszeres formázás konzisztens fájlokat tart és az ügyleteket megfogja, mielőtt elérné a CI-t.
A YAML és JSON közötti konvertálás egyaránt hasznos. Néhány eszköz csak JSON-t fogad el API hívásokhoz vagy séma definíciókhoz, míg az emberek általában hosszú élettartamú konfigurációs fájlokhoz YAML-t preferálnak. Az adattípusok elvesztése nélküli körbefordulást — a számok számok maradnak, az logika értékek logika értékek maradnak — az időt takarít meg és megelőz finom hibákat.
Hogyan formázz vagy konvertálj YAML-t
- 01
Illeszd be a YAML-t vagy JSON-t
Illeszd be a Kubernetes manifest-et, a GitHub Actions workflow-t, a Helm értékeket vagy bármilyen más YAML dokumentumot. JSON-JSON konvertáláshoz illeszd be helyett a JSON-t.
- 02
Válassz egy műveletet
Válassza a YAML formázás lehetőséget a behúzás normalizálásához és a dokumentum helyén való tisztításához. Válassza a YAML-JSON vagy JSON-YAML-t a formátum teljes konvertálásához.
- 03
Tekintsd meg a hibákat, ha vannak
Ha a bemenet szintaxis hibájához vezet, az eszköz a js-yaml elemzőből az pontos sorszámot és okot jeleníti meg — ugyanaz az elemző, amely a Node.js tooling-ban használatos, így a hiba megegyezik azzal, amit a termelésben látnál.
- 04
Másold ki a kimenetet
Kattints a Másol gombra, hogy megkapd a formázott vagy konvertált kimenetet. Illeszd be vissza a konfigurációs fájlodba, egy API szöveghez vagy egy séma meghatározásba.
Mikor takarít meg ez az eszköz időt
- 01A Kubernetes manifest sodródott — normalizálja a behúzást a commit előtt.
- 02A GitHub Actions workflow nem elemez — validálj, hogy az pontos hibasort kapd.
- 03Az API csak JSON-t fogad, de a konfiguráció YAML-ként kerül tárolásra — konvertálj egyetlen kattintásban.
- 04Egy új szolgáltatás bevezetése — konvertáld a JSON példa terheit YAML-ra a Helm diagramhoz.
- 05A Stack Overflow-ból másolt YAML — formázz újra, hogy megfeleljen a projekt 2 szóköz stílusának.
- 06Helm értékek összevonásának hibakeresése — validáld, hogy az egyes values.yaml egyenként tiszta.
Privát, nincs feltöltés szükséges
A formázás és konvertálás teljes egészében a böngészőben futnak a js-yaml használatával — ugyanaz a könyvtár, amelyet a Webpack, Rollup és a legtöbb JavaScript buildjében bundleeltek. A konfigurációs fájlok, titok hivatkozások és környezeti változó nevek soha nem hagyják el az eszközt.
Az elemző a YAML 1.2-re irányul, amely az összes Kubernetes, GitHub Actions és Docker Compose használt. Ha egy fájl itt validál, az helyesen betölt azokban az eszközökben.
YAML Formázó GYIK
Megtartja a YAML formázása a megjegyzéseket?
Nem. A js-yaml elemző az elemzés során eltávolítja a megjegyzéseket — ez az összes JavaScript YAML elemzőfelhasználatban korlátozás. Formázz először, majd manuálisan add vissza a megjegyzéseket.
Mely YAML verziót támogatja ez?
YAML 1.2, amely a Kubernetes, GitHub Actions, Docker Compose és Helm által használt verzió. Az itt validált betöltődik egyértelműen ezekben az eszközökben.
Az YAML JSON-ra való konvertálása megőrzi az típusokat?
Igen. A számok, logika értékek, null és dátum karakterláncok helyesen körbefordulnak. A YAML-ban igaz egy logika értéke igaz JSON-ban, nem a karakterlánc 'true'.
Mi a különbség a formázás és konvertálás között?
A formázás a fájlt YAML-ként tartja és normalizálja a szóközt és behúzást. A konvertálás a kimeneti formátumot teljesen megváltoztatja — YAML JSON-ra egy .json-kompatibilis dokumentumot produkál.
Az én YAML-omnak több dokumentuma van --- által elválasztva. Mindet feldolgozzák?
Az első dokumentum elemzésre és újra kibocsátásra kerül. A multi-dokumentum fájlok esetében felosztsd az egyes szekciót az --- ban és dolgozz fel őket egyenként.