Validator YAML: periksa YAML saat Anda mengetik
Tempel YAML Anda, dan validator YAML ini memeriksanya saat Anda mengetik. Setiap kesalahan sintaks dijelaskan dengan bahasa sederhana, lengkap dengan baris dan kolom. Alat ini menemukan indentasi dengan tab, kunci ganda, tanda kutip dan kurung yang belum ditutup, serta spasi tanpa jeda yang tak terlihat dan tampak seperti indentasi padahal bukan. YAML Anda diperiksa di browser Anda dan tidak pernah diunggah.
Cara memakai YAML checker ini langkah demi langkah
Tempel atau ketik YAML Anda di kotak YAML. Tidak ada tombol validasi: teks diperiksa secara langsung.
- Teks yang ditempel diperiksa seketika. Saat Anda mengetik, pemeriksaan berjalan sekitar seperempat detik setelah tombol terakhir, sedikit lebih lama untuk teks yang sangat besar. Hasil sebelumnya tetap tampak redup sampai hasil baru muncul.
- Baca kotak di bawah editor. Kotak hijau YAML valid berarti sintaksnya benar. Kotak merah “YAML tidak valid” (atau “YAML tidak valid: N masalah”) mencantumkan apa yang salah.
- Setiap masalah memuat satu kalimat, “Baris N, kolom M”, dan potongan baris dengan nomor baris: dua baris di atas, satu baris di bawah, dan tanda ^ di bawah kolom.
- Pilih Tampilkan di editor untuk memilih baris itu di dalam kotak, perbaiki, lalu lihat kotaknya berubah hijau.
Hanya kesalahan sintaks pertama dari setiap dokumen yang dilaporkan. Kesalahan sesudahnya biasanya efek samping, misalnya tanda kutip yang hilang sehingga baris di bawahnya ikut tertelan. Kunci ganda dan alias yang belum didefinisikan selalu dicantumkan semuanya, dan paling banyak 20 masalah ditampilkan.
YAML error yang umum dan cara memperbaikinya
Setiap error dijelaskan dengan satu kalimat, bukan pesan mentah dari parser. Ini yang paling sering ditemui:
- Baris menjorok dengan tab. Editor menyisipkan tab, atau tab ikut tertempel. Ganti tab dengan spasi.
- Baris tidak sejajar dengan kunci lain dalam mapping-nya. Satu kunci punya spasi lebih banyak atau lebih sedikit daripada kunci di sebelahnya. Beri kunci pada tingkat yang sama indentasi yang sama.
- Indentasi salah. Blok bersarang tidak menjorok lebih dalam daripada induknya. Jorokkan anak lebih dalam daripada kunci induk.
- Sebuah kunci muncul lebih dari sekali dalam mapping yang sama (YAML duplicate key). Biasanya blok yang disalin meninggalkan kunci berulang. Gabungkan atau hapus duplikatnya.
- Baris bukan pasangan kunci: nilai. Titik dua hilang, atau baris yang terpotong tidak menjorok. Tambahkan
:setelah kunci atau jorokkan lanjutannya. - Sebuah pasangan ditulis di dalam pasangan lain pada baris yang sama. Biasanya ada titik dua kedua di nilai biasa, seperti pada
a: b: c. Letakkan nilai dalam tanda kutip atau gunakan baris baru yang menjorok. - Sebuah kurung tidak pernah ditutup, atau tanda kutip tidak berakhir. Pesan menunjuk baris tempat ia dibuka. Tambahkan penutupnya.
- Koma hilang di antara item dalam
[ ]atau{ }. Dua item menempel. Tambahkan komanya. - Nilai diawali
@atau tanda petik balik. Letakkan nilai dalam tanda kutip. - Tanda
#menempel pada kata sebelumnya. Komentar baru dimulai jika ada spasi sebelumnya. Tambahkan spasi atau letakkan teks dalam tanda kutip. \qbukan escape yang valid dalam tanda kutip ganda. Ini sering terjadi pada path Windows. Tulis\\atau gunakan tanda kutip tunggal.- Sebuah alias menunjuk anchor yang tidak didefinisikan di atasnya. Definisikan
&namalebih awal di dalam berkas. - Bagian ini tidak cocok di sini. Sering kali daftar dengan
-bercampur dengan bariskunci: nilaipada tingkat yang sama, atau baris di atasnya belum selesai. Letakkan daftar di bawah kuncinya sendiri dan periksa baris di atasnya. - Direktif
%di awal dokumen tidak valid atau tidak didukung. Hapus, atau gunakan%YAMLatau%TAGdengan benar.
Arti pesan error dari parser lain
Datang dari pesan di terminal atau log CI? Beginilah rumusan yang umum berpadanan dengan apa yang dilaporkan validator ini. Tempel berkas yang sama dan baris-nya akan ditampilkan.
found character that cannot start any token while scanning for the next token: tab di awal baris, atau nilai yang diawali@atau tanda petik balik.tabs are not allowed for indent: tab dipakai sebagai indentasi.mapping values are not allowed here: titik dua kedua pada satu baris, sepertia: b: c, nilai tanpa tanda kutip yang memuat:, atau baris yang menjorok di bawah kunci yang sudah punya nilai.did not find expected key: baris yang tidak sejajar dengan kunci lain dalam mapping-nya.bad indentation of a mapping entry: kunci dengan kedalaman indentasi yang salah.could not find expected ':': baris tanpa titik dua setelah kunci.
Rumusannya berbeda antarparser (PyYAML, js-yaml, Ruby, Go, loader Home Assistant dan ESPHome), dan parser sering melaporkan baris di bawah kesalahan yang sebenarnya. Validator ini menunjuk baris yang dapat ditampilkannya kepada Anda.
Tab dan karakter tak terlihat
Dua kesalahan YAML yang paling sulit ditemukan adalah yang tidak terlihat. Validator ini membuatnya terlihat.
- Tab pada potongan baris digambar sebagai panah, dan spasi tanpa jeda atau spasi lebar nol digambar sebagai titik.
- Jika baris yang bermasalah memuat karakter tak terlihat, satu baris tambahan menyebutkannya lengkap dengan code point, misalnya
U+00A0, dan kolomnya. Yang tercakup adalah spasi tanpa jeda, karakter lebar nol, penanda urutan byte, dan spasi lebar penuh. - Jika berkas valid tetapi sebuah baris diawali spasi tak terlihat, kotak kuning Valid, tetapi periksa baris ini muncul di bawah kotak hijau. YAML membaca karakter itu sebagai bagian dari kunci, jadi baris tersebut sebenarnya tidak menjorok. Teks yang disalin dari halaman web, wiki, atau aplikasi obrolan adalah sumber yang paling umum.
Contoh: dalam berkas dengan server: dan di bawahnya port: 8080, baris terakhir, host: example.com, diawali dua spasi tanpa jeda, bukan dua spasi biasa. YAML membacanya sebagai kunci tingkat atas tersendiri, dan host bukan anak dari server. Kotak kuning menyebutkan karakter dan barisnya.
Format YAML online dan salin hasilnya
Aktifkan sakelar Rapikan YAML di atas kotak. Sakelar ini mati secara bawaan. Jika teks valid, muncul blok YAML terformat dengan tombol Salin di atasnya, yang berubah menjadi Tersalin setelah menyalin. Hasil rapinya dapat diprediksi:
- Indentasinya 2 spasi. Tidak ada lebar lain, dan daftar di bawah kunci dijorokkan.
- Komentar, anchor, alias, gaya tanda kutip, dan urutan kunci dipertahankan.
- Baris panjang tidak pernah dipecah.
- Beberapa dokumen tetap memakai pemisah
---.
Hanya YAML yang valid yang bisa dirapikan, jadi berkas yang rusak tidak bisa diperbaiki dengannya: perbaiki dulu errornya. Keluaran yang sangat panjang ditampilkan terpotong setelah 600.000 karakter, dan Salin tetap menyalin semuanya.
YAML lint online: penggunaan, ukuran, dan batasan
Pemeriksaannya sama untuk apa pun kegunaan YAML Anda. Alat ini bisa dipakai untuk alur kerja GitHub Actions, docker-compose.yml, manifes Kubernetes dan nilai Helm, berkas OpenAPI, playbook Ansible, konfigurasi Home Assistant, templat CloudFormation, dan konfigurasi mkdocs. Tempel berkas sebelum commit, dan kesalahan sintaks muncul tanpa menunggu proses CI. Berkas dengan beberapa dokumen yang dipisahkan --- diperiksa dokumen demi dokumen, dan kotak hijau menyebutkan jumlah yang ditemukan. Anchor (&nama) dan alias (*nama) diperiksa. Tag kustom seperti !Ref, !Sub, dan !GetAtt milik CloudFormation, atau !reference milik GitLab, diterima sebagai valid.
Pemeriksaan berjalan di Web Worker pada browser Anda. Berkas konfigurasi, CI, dan Kubernetes yang umum diperiksa dalam sekejap. Batasnya 5.000.000 karakter, dan teks yang mendekatinya butuh beberapa detik dan banyak memori. Di atas batas itu, Anda diminta menempel potongan yang lebih kecil.
Yang diperiksa hanya sintaks YAML. Alat ini tidak tahu apa yang diharapkan sebuah program tertentu, jadi bidang Kubernetes, kunci GitHub Actions atau Docker Compose, dan aturan JSON Schema tidak diperiksa, dan nama kunci yang salah eja tetap lolos. Alat ini mengikuti YAML 1.2, jadi kata yes, no, on, dan off dari YAML 1.1 adalah teks biasa dan tidak pernah dinilai. Alat ini tidak menjalankan, mengambil, atau memuat apa pun, dan satu carriage return Mac lama yang berdiri sendiri tidak dianggap sebagai pemisah baris.
Bekerja dengan format lain? Rapikan dan periksa JSON dengan Pemformat JSON, cocokkan dengan skema memakai Validator JSON Schema, atau periksa markup dengan Validator XML. Mencari pola di konfigurasi Anda? Cobalah di Penguji Regex.
Pertanyaan yang sering diajukan
Bagaimana cara memakai validator YAML online?
Tempel YAML Anda di kotak “YAML”. Teks diperiksa saat Anda menempel atau mengetik, jadi tidak ada tombol yang perlu ditekan. Kotak hijau “YAML valid” berarti sintaksnya benar. Kotak merah “YAML tidak valid” menampilkan setiap masalah dengan bahasa sederhana, lengkap dengan “Baris N, kolom M” dan potongan barisnya.
Mengapa YAML mengatakan tab tidak diizinkan untuk indentasi?
YAML hanya mengizinkan spasi untuk indentasi, dan tab di awal baris adalah kesalahan sintaks. Editor sering menyisipkan tab saat Anda menekan tombol Tab, atau tab ikut tertempel bersama teks. Validator memberi tahu bahwa baris itu menjorok dengan tab. Ganti tab dengan spasi.
Apa arti “mapping values are not allowed here” di YAML?
Biasanya ada titik dua kedua pada satu baris, seperti “a: b: c”, atau nilai tanpa tanda kutip memuat titik dua. Bisa juga baris yang menjorok di bawah kunci yang sudah punya nilai. Letakkan nilai dalam tanda kutip atau tulis pasangan bagian dalam di barisnya sendiri yang menjorok.
Apa arti “did not find expected key” di YAML?
Sebuah baris tidak sejajar dengan kunci lain dalam mapping-nya. Biasanya satu kunci punya spasi lebih banyak atau lebih sedikit daripada kunci di sebelahnya. Beri semua kunci pada tingkat yang sama indentasi yang sama. Validator melaporkannya sebagai baris yang tidak sejajar dengan kunci lain.
Bagaimana menemukan kunci ganda di YAML?
Tempel teksnya. Kunci ganda dalam mapping yang sama selalu dicantumkan semuanya, masing-masing dengan baris dan kolom. Biasanya blok yang disalin meninggalkan kunci berulang. Gabungkan entrinya atau hapus duplikatnya.
Mengapa YAML yang valid menampilkan “Valid, tetapi periksa baris ini”?
Sebuah baris diawali spasi tak terlihat, misalnya spasi tanpa jeda. YAML membacanya sebagai bagian dari kunci, jadi baris itu sebenarnya tidak menjorok walaupun berkasnya valid. Kotak kuning menyebutkan karakter dan barisnya. Hapus dan ketik spasi biasa.
Bisakah saya memeriksa YAML GitHub Actions, Docker Compose, atau Kubernetes di sini?
Bisa, pemeriksaan sintaksnya sama untuk semua YAML. Alat ini berlaku untuk alur kerja, docker-compose.yml, manifes Kubernetes, dan banyak berkas lain. Yang diperiksa hanya sintaks: validator tidak tahu kunci apa yang diharapkan tiap program, dan nama kunci yang salah eja tetap lolos.
Seberapa besar berkas YAML yang bisa diperiksa?
Batasnya 5.000.000 karakter. Berkas konfigurasi yang umum diperiksa dalam sekejap, dan teks yang mendekati batas butuh beberapa detik dan banyak memori. Di atas batas, Anda diminta menempel potongan yang lebih kecil.