Fara í aðalefni

Hvernig forritarar kemba config snippets með JSON, YAML og TOML hlið við hlið

Eftir Converty Team

Lærðu hvernig forritarar geta kembt config snippets með því að breyta JSON, YAML og TOML hlið við hlið svo uppbyggingarvandamál sjáist áður en gögnin fara í pipeline.

Hvernig forritarar kemba config snippets með JSON, YAML og TOML hlið við hlið

Config-debugging fer oft rangt af stað þegar forritari horfir bara á setningafræði. Snippet getur verið gilt JSON eða YAML en samt með ranga lögun fyrir kerfið sem þarf að lesa það. Þá fara menn að breyta inndrætti, gæsalöppum eða lyklaheitum án þess að staðfesta fyrst gagnalíkanið.

Converty JSON / YAML / TOML-breytirinn gerir hraða hlið-við-hlið skoðun: límdu snippetið, staðfestu parsing og sjáðu hvernig sömu gögn líta út í JSON, YAML og TOML þegar það er samhæft.

Hættu að stara á eina setningafræði

Snippet getur komið úr skjölum, API-svari eða gömlu config-dæmi. Ef það bilar í nýju kerfi er ekki alltaf rétta fyrsta skrefið að laga textann í blindni. Betra er að sjá hvort nesting, listar og hlutir séu eins og þú heldur.

Pretty JSON getur gert uppbygginguna skýrari. YAML getur sýnt hana læsilega. TOML getur þrýst á mörk gagnalíkansins og sýnt að top-level lögun passi ekki.

Hagnýtt debug-pass

  1. Límdu snippetið í JSON / YAML / TOML-breytinn.
  2. Lagaðu parsing-villur fyrst.
  3. Berðu saman pretty JSON og YAML.
  4. Athugaðu hvort TOML birtist; ef ekki, skoðaðu hvort uppbyggingin sé TOML-væn.
  5. Afritaðu það snið sem hjálpar þér að halda áfram í raunverulega kerfinu.

Þetta kemur ekki í stað test environment. Það fækkar blindum breytingum áður en þú ferð þangað.

Browser fyrst, CLI seinna

Vafratengt verkfæri er gott fyrir skoðun og staka greiningu. Þegar umbreytingin er orðin stöðug og þarf að endurtaka, flyttu hana í CLI með tóli eins og yq.

Converty vs yq fyrir JSON og YAML afhendingar fjallar um þessa línu. Af hverju TOML-úttak er ekki tiltækt fyrir sum JSON eða YAML inntök útskýrir þegar vantað úttak er nytsamleg vísbending.

Kembdu lögunina fyrst

Bestu config-debugging loturnar skilja á milli skoðunar og sjálfvirkni. Fyrst sannarðu hvað gögnin eru. Síðan ákveðurðu hvernig þau eiga að breytast aftur og aftur.

Opnaðu JSON / YAML / TOML-breytinn þegar vandinn er enn óljós, og notaðu JSON, YAML og TOML breytt án þess að skaða gögn sem breiðari leiðbeiningu.

Þér gæti líka líkað