Nyahpepijat kesilapan lekukan YAML dengan menukarnya kepada JSON

Langkah yang tidak pernah dijalankan — fail aliran kerja yang dihuraikan dengan baik dan kunci yang berakhir satu tahap terlalu tinggi

Aliran kerja boleh menghuraikan dengan jayanya sambil meletakkan `with` di sebelah satu langkah dan bukannya di dalamnya. Pelari kemudian mengabaikan atau menolak bentuk kemudian, dan pemeriksaan visual terlepas peralihan kerana sumbernya kekal kemas. Menukar kepada JSON mendedahkan induk sebenar melalui pendakap dan sempadan tatasusunan.

ToolAcre melaporkan salah bentuk YAML dengan baris dan lajur, tetapi struktur salah yang sah tidak menghasilkan ralat sintaks. Oleh itu, pepohon yang ditukar ialah pandangan diagnostik: ia memberitahu anda perkara yang diterima oleh penghurai ini, bukan maksud skema aliran kerja.

Mengapa kesilapan lekukan selalunya bukan ralat — struktur YAML ialah ruang kosong, jadi garis yang dialihkan biasanya mencipta dokumen yang sah tetapi berbeza

Ruang kosong membawa hierarki YAML. Menggerakkan baris ke kiri boleh menjadikan kanak-kanak menjadi adik beradik; menggerakkan sengkang boleh meletakkan item dalam urutan lain. Kedua-dua dokumen mungkin memenuhi tatabahasa YAML. Pengesahan sintaks tidak dapat menentukan sarang yang sepadan dengan aplikasi.

Tab dalam lekukan ditolak oleh penghurai dan menerima kedudukan. Ruang yang menghasilkan hierarki sah yang salah memerlukan perbandingan struktur sebaliknya. Perbezaan itu menjelaskan mengapa sesetengah kesilapan lekukan gagal serta-merta manakala yang lain bertahan sehingga kelakuan aplikasi.

Perkara yang JSON jelas — pendakap dan kurungan yang menunjukkan dengan tepat objek mana yang dimiliki oleh kunci

JSON menulis sempadan objek dengan pendakap dan ahli tatasusunan dengan kurungan. Kekunci YAML yang salah letak muncul di luar objek yang anda jangkakan, dan sengkang menjadi sempadan tatasusunan yang sukar untuk diabaikan. Lekukan dalam cantik JSON ialah pembentangan; tanda baca mentakrifkan struktur.

Pandangan juga mendedahkan jenis yang diselesaikan. Skalar yang tidak disebut mungkin nol, nombor atau Boolean di bawah skema yang dipilih. Membetulkan hierarki tanpa menyemak nilai boleh meninggalkan pepijat kedua, jadi bandingkan kedua-dua laluan harta dan jenis JSON.

Bentuk biasa kesilapan — item senarai di bawah ibu bapa yang salah, kunci yang menjadi adik beradik dan bukannya anak dan tab bercampur dengan ruang

Kesilapan biasa termasuk item jujukan yang diselaraskan dengan senarai yang salah, kunci pemetaan yang diketepikan kepada adik-beradik dan aksara tab bercampur dengan ruang. Kekunci pendua ialah perangkap lain: ToolAcre menyimpan nilai terakhir dan memberi amaran dengan kedudukan, jadi JSON mengandungi sahaja harta yang masih hidup.

Penambat boleh menjadikan hasil kelihatan lebih besar kerana alias berkembang menjadi data berulang. Itu dijangka untuk penukaran ini dan tidak boleh dikelirukan dengan lekukan tidak sengaja. Baca amaran sebelum mengaitkan setiap perbezaan struktur dengan ruang kosong.

Contoh berfungsi: aliran kerja CI dengan satu blok 'dengan' tersilap inden — menukar kepada JSON, mengesan kunci yang salah letak, membetulkan dan menukar semula

Buat kerja yang disunting dengan `steps`, satu entri `uses` dan pemetaan `with`. Outdent `with` jadi ia menjadi adik beradik kepada `steps`, kemudian tukar. Pendakap JSON menunjukkan bahawa `with` adalah milik tugas dan bukannya objek langkah. Alihkannya di bawah item senarai dan tukar semula untuk melihat sarang yang dimaksudkan.

Contoh ini mengelak daripada mendakwa cara perkhidmatan CI tertentu bertindak balas, kerana penukar tidak memuatkan skema tersebut. Buktinya ialah hierarki yang dihuraikan. Pengesahan skema harus mengikuti dan kemudian boleh melaporkan sama ada `with` diterima di laluan yang diperbetulkan.

Menggunakan penukaran terbalik — JSON kepada YAML untuk menghasilkan versi inden yang betul anda boleh tampal kembali

Selepas struktur JSON betul, menukarkannya kembali kepada YAML menghasilkan lekukan yang konsisten daripada penyeri bersiri. Rentetan samar-samar mungkin mendapat petikan, dan ulasan tidak dipulihkan. Anggap output sebagai siri data yang bersih, bukan pemformat yang memelihara sumber.

Jika komen asal menerangkan pilihan operasi, salin struktur yang diperbetulkan ke dalam fail yang diselenggara dan bukannya menggantikannya secara membuta tuli. Fail yang dijana boleh betul dari segi struktur dan tidak lengkap dari segi editorial.

Perkara yang tidak dicakupi ini — pengesahan semantik terhadap aliran kerja atau skema manifes, yang menangkap kunci yang tidak diketahui dan bukannya yang salah letak

Tiada aliran kerja, Karang, Kubernetes atau skema aplikasi terlibat. Kunci boleh diletakkan di bawah induk yang dimaksudkan dan masih tersilap ejaan atau tidak disokong. Penukar sintaks sahaja membuktikan bahawa YAML diterima dan menunjukkan nilai berbentuk JSON yang terhasil.

Gunakan pengesah platform yang memiliki untuk kunci yang tidak diketahui, medan yang diperlukan dan kekangan semantik. Menyimpan semakan sintaks dan skema secara berasingan menghasilkan kegagalan yang lebih jelas dan mengelakkan pengkreditan penukar generik dengan pengetahuan domain yang tidak dimilikinya.

Bawa pulang: apabila YAML kelihatan betul dan berkelakuan salah, lihat ia sebagai JSON — dan cara panel penukar Sintaks melakukannya dengan serta-merta

Apabila YAML kelihatan betul tetapi berkelakuan salah, periksa pokok yang dihuraikan. JSON pendakap dan kurungan menjadikan induk jelas, manakala amaran ToolAcre mendedahkan pendua, strim dan perubahan nilai yang boleh merumitkan gambar.

Betulkan satu ralat hierarki, tukar semula dan kemudian jalankan pengesahan skema. Urutan ini menukar syak ruang kosong yang tidak kelihatan kepada struktur yang boleh diperhatikan tanpa mendakwa bahawa penukaran yang berjaya menjadikan konfigurasi itu sah untuk destinasinya.

Apabila membandingkan sebelum dan selepas, fokus pada laluan sifat dan bukannya nombor baris kerana siri boleh menyusun semula pembentangan atau menambah petikan. Semakan berguna menyenaraikan laluan yang dijangka, jenis JSON dan sama ada ia terletak di dalam objek atau tatasusunan. Senarai semak kecil itu menangkap kunci tersalah letak kedua walaupun simptom visual pertama telah ditetapkan, dan ia mengelak daripada menukar pemformatan YAML yang dijana menjadi oracle ujian.