ตัวจัดรูปแบบและตรวจสอบ YAML

YAML ใช้การย่อหน้า (spaces) เพื่อกำหนดโครงสร้างเอกสารและการซ้อนทับ — ไม่มีเครื่องหมายปีกกาหรือแท็กปิดเหมือนใน JSON หรือ XML ระดับการย่อหน้าขององค์ประกอบจะเป็นตัวกำหนดว่าเป็นบุตร (child) ขององค์ประกอบที่อยู่เหนือมันหรือเป็นพี่น้อง การเว้นวรรคเกินมาหนึ่งตำแหน่งหรือขาดไปเพียงตำแหน่งเดียวสามารถเปลี่ยนความหมายได้อย่างสิ้นเชิง: กุญแจ (key) ที่ควรจะเป็นคุณสมบัติย่อยของการนิยามบริการอาจกลายเป็นกุญแจระดับบนแทน โดยบ่อยครั้งไม่มีข้อความแจ้งเตือนข้อผิดพลาดจาก YAML parser นี่คือเหตุผลว่าทำไมข้อผิดพลาดใน YAML ถึงยากต่อการดีบั๊กอย่างยิ่ง — อาการ (การตั้งค่าที่ผิด) อาจอยู่ห่างไกลจากสาเหตุ (ช่องว่างที่หลงเหลืออยู่ในบรรทัดที่ 47)

ไม่ได้ ข้อกำหนดของ YAML ห้ามใช้ตัวอักษร tab สำหรับการย่อหน้าอย่างชัดเจน Tabs อนุญาตให้ใช้ภายในเครื่องหมายคำพูด (quoted strings) แต่ห้ามใช้ในการย่อหน้า หากตัวแก้ไขของคุณถูกตั้งค่าให้ใส่ tabs เมื่อกด Tab ให้เปลี่ยนเป็นใส่ spaces สำหรับไฟล์ YAML บั๊กที่เกี่ยวข้องกับ YAML จำนวนมากเกิดจาก tabs ที่มองไม่เห็นในไฟล์ที่ดูเหมือนจะย่อหน้าถูกต้อง เครื่องมือจัดรูปแบบนี้จะตรวจจับและปรับการย่อหน้าแบบ tab ให้เป็น spaces

เครื่องมือจัดรูปแบบนี้รองรับคุณสมบัติครบถ้วนของ YAML 1.2: scalar types (strings, integers, floats, booleans, null), block mappings (key: value), block sequences (- item), flow style (inline {} และ []), multiline strings (literal block | และ folded block >), comments (#), anchors (&anchor) และ aliases (*alias), multiple documents (--- separator), และ explicit type tags (!!str, !!int, ฯลฯ) โครงสร้างการย่อหน้าที่ซับซ้อน เช่น Kubernetes pods พร้อม volumes, env arrays และ resource limits จะถูกจัดรูปแบบอย่างถูกต้อง

คอมเมนต์จะได้รับการตรวจสอบระหว่างการ validate และ parsing ในระหว่างการจัดรูปแบบ เครื่องมือจะทำการ re-serialize โครงสร้างข้อมูลที่ถูก parse — เนื่องจาก YAML parser ส่วนใหญ่ไม่ได้แนบคอมเมนต์เข้ากับ data model คอมเมนต์อาจไม่ถูกเก็บรักษาไว้ทั้งหมดในผลลัพธ์ที่จัดรูปแบบแล้ว สำหรับจุดประสงค์ในการตรวจสอบ (เพื่อดูความถูกต้องของโครงสร้าง) คอมเมนต์จะได้รับการจัดการอย่างถูกต้อง หากการรักษาคอมเมนต์ไว้อย่างครบถ้วนเป็นเรื่องสำคัญ ให้คัดลอกเวอร์ชันที่จัดรูปแบบแล้วกลับไปยังตัวแก้ไขของคุณและเพิ่มคอมเมนต์ด้วยตนเองอีกครั้ง

ข้อผิดพลาดที่พบบ่อยที่สุดคือ: (1) การย่อหน้าที่ไม่สอดคล้องกัน — การผสมกันระหว่างการย่อหน้าแบบ 2-space และ 4-space หรือ tabs ผสมกับ spaces (2) กุญแจซ้ำใน mapping เดียวกัน (3) strings ที่ไม่ได้อยู่ในเครื่องหมายคำพูดซึ่ง YAML ตีความว่าเป็นค่าพิเศษ — "yes", "no", "true", "false", "null", "on", "off" ทั้งหมดจะถูกตีความว่าเป็น booleans หรือ null ใน YAML 1.1 (พบได้บ่อยใน Kubernetes configs รุ่นเก่า) (4) เครื่องหมายโคลอนโดยไม่มีช่องว่างในกุญแจที่ไม่มีเครื่องหมายคำพูด (5) การขาดช่องว่างหลังเครื่องหมายโคลอนในคู่ key: value (6) strings ที่ไม่มีเครื่องหมายคำพูดและมีตัวอักษรพิเศษของ YAML (: { } [ ] # &)

YAML เป็น superset ของ JSON — JSON ที่ถูกต้องจะถือเป็น YAML ที่ถูกต้องด้วย YAML เพิ่มคุณสมบัติที่เป็นมิตรต่อมนุษย์ซึ่ง JSON ไม่มี: คอมเมนต์, multiline strings, anchors/aliases สำหรับการใช้ค่าซ้ำ และเครื่องหมายน้อยลง (ไม่ต้องมีเครื่องมาตราระหว่างรายการใน array, ไม่ต้องมีเครื่องหมายคำพูดสำหรับค่า string แบบง่าย) JSON มีข้อดีสำหรับการสร้างข้อมูลด้วยเครื่องจักร: ไม่มีความอ่อนไหวต่อการย่อหน้า, ได้รับการรองรับโดยพื้นฐานจากทุกภาษา และไม่มีความกำกวม สำหรับไฟล์การตั้งค่าที่แก้ไขด้วยมือ YAML มักจะเป็นที่นิยมมากกว่า สำหรับการตอบกลับของ API และการจัดเก็บข้อมูล JSON เป็นตัวเลือกหลัก

ไม่ การจัดรูปแบบและการตรวจสอบทั้งหมดทำงานในเบราว์เซอร์ของคุณโดยใช้ JavaScript YAML parser ไฟล์การตั้งค่าของคุณ ซึ่งอาจมีตัวแปรสภาพแวดล้อม (environment variables), ข้อมูลยืนยันตัวตน และรายละเอียดโครงสร้างพื้นฐาน จะไม่มีวันออกจากอุปกรณ์ของคุณเลย