ตัวจัดรูปแบบ YAML
จัด YAML ให้อ่านง่ายโดยรักษา mapping, sequence, scalar, เครื่องหมายอัญประกาศ และความคิดเห็นไว้
Make YAML structure easier to read
YAML ที่เยื้องไม่สม่ำเสมออาจซ่อนความสัมพันธ์ parent-child รายการ และค่า scalar เครื่องมือนี้แสดงโครงสร้างด้วยบรรทัดและการเยื้องที่สม่ำเสมอ
การจัดรูปแบบไม่ยืนยันว่า YAML ตรงตาม schema หรือสัญญาของแอป ควรเปรียบเทียบ key ค่า ลำดับ quote และความคิดเห็นกับต้นฉบับ
เริ่มจากตัวอย่างเล็ก เก็บ source ผลลัพธ์ parser และ schema แยกกัน
สำหรับค่าการผลิตให้ตรวจ diff เพราะไฟล์ที่อ่านง่ายยังมีค่าที่อันตราย type ที่ไม่คาดคิด หรือ alias ได้
Formatting is not YAML validation
YAML แสดง mapping sequence scalar ความคิดเห็น anchor alias และขอบเขตเอกสารด้วย whitespace และเครื่องหมาย
ตัวจัดรูปแบบจัดโครงสร้างแต่ไม่รับรอง JSON Schema OpenAPI Kubernetes หรือกฎ CI
ข้อความธรรมดา ข้อความใน quote boolean null ตัวเลข และ block หลายบรรทัดอาจถูก parser ตีความต่างกัน
ความคิดเห็นช่วยผู้อ่านแต่ไม่ใช่ข้อมูลแอปโดยทั่วไป ต้องตรวจว่า serializer ปลายทางเก็บไว้หรือไม่
How to format YAML
- ใส่เอกสาร YAML ครบหรือ fragment ที่มีคำอธิบาย
- ตรวจ mapping เครื่องหมายรายการ การเยื้อง quote ความคิดเห็น และ block
- เปรียบเทียบความหมายของ key ค่า ลำดับ anchor alias และ marker กับต้นฉบับ
- รัน parser schema validator linter และการทดสอบแอปที่ต้องใช้
- ลบความลับและข้อมูลส่วนบุคคลจากตัวอย่าง production แล้วเก็บต้นฉบับ
Formatting method
- อ่าน mapping sequence
อ่าน mapping sequence รูปแบบ scalar ความคิดเห็น และขอบเขตเอกสารจาก YAML
- เพิ่มบรรทัดใหม่และการเยื้องเพื่อให้ key แม่และค่าลูกเห็นชัด
เพิ่มบรรทัดใหม่และการเยื้องเพื่อให้ key แม่และค่าลูกเห็นชัด
- รักษา quoted string
รักษา quoted string boolean ตัวเลข anchor alias block และความคิดเห็นตาม source
เวอร์ชัน parser การแปลง scalar การเก็บความคิดเห็น การจัดการ alias และข้อความ error ที่แน่นอนต้องตรวจด้วย engine จริง
Read the formatted result
ผลสำเร็จคือ YAML ที่จัดวางให้อ่านง่าย ตรวจ tree ค่า ลำดับ ความคิดเห็น และรูปแบบ scalar ให้ตรงต้นฉบับ
ผลล้มเหลวไม่ได้พิสูจน์กฎ parser เฉพาะ ต้องใช้หลักฐาน runtime ระบุตำแหน่ง
ข้อผิดพลาดของ schema หรือแอปเป็นสัญญาอีกส่วน การจัดรูปแบบไม่เพิ่ม key ที่จำเป็นและไม่พิสูจน์ความปลอดภัยของ type
ข้อผิดพลาดที่พบบ่อย
การมองการเยื้องเป็นการตรวจ schema อาจซ่อน key ที่หายหรือ type ที่ผิด
การลบ quote จากวันที่ colon boolean หรือเลขศูนย์นำหน้าอาจเปลี่ยนการตีความ
การเรียง list หรือ mapping เพื่อความสวยงามอาจเปลี่ยนค่าที่ไวต่อลำดับ
การทดสอบ fragment ที่ไม่มี anchor alias หรือการเยื้องของ parent อาจต่างจาก production
ข้อจำกัดและกรณีพิเศษ
ความสามารถนี้คือการจัด YAML ไม่รับรอง schema linter การจัดการความลับ transformation หรือ compatibility
การแปลง scalar key ซ้ำ anchor alias block และ YAML version ต้องทดสอบกับ parser เป้าหมาย
อย่าใส่การตั้งค่าลับของ production หากนโยบายไม่อนุญาต
Examples
การจัดรูปแบบตรวจ YAML schema หรือไม่
การจัดรูปแบบตรวจ YAML schema หรือไม่
ใส่เอกสาร YAML ครบหรือ fragment ที่มีคำอธิบาย
ผลสำเร็จคือ YAML ที่จัดวางให้อ่านง่าย ตรวจ tree ค่า ลำดับ ความคิดเห็น และรูปแบบ scalar ให้ตรงต้นฉบับ
ชนิด scalar จะเปลี่ยนไหม
ชนิด scalar จะเปลี่ยนไหม
ตรวจ mapping เครื่องหมายรายการ การเยื้อง quote ความคิดเห็น และ block
ผลล้มเหลวไม่ได้พิสูจน์กฎ parser เฉพาะ ต้องใช้หลักฐาน runtime ระบุตำแหน่ง
ความคิดเห็นถูกเก็บไว้ไหม
ความคิดเห็นถูกเก็บไว้ไหม
เปรียบเทียบความหมายของ key ค่า ลำดับ anchor alias และ marker กับต้นฉบับ
ข้อผิดพลาดของ schema หรือแอปเป็นสัญญาอีกส่วน การจัดรูปแบบไม่เพิ่ม key ที่จำเป็นและไม่พิสูจน์ความปลอดภัยของ type
จัด fragment ได้ไหม
จัด fragment ได้ไหม
รัน parser schema validator linter และการทดสอบแอปที่ต้องใช้
ผลสำเร็จคือ YAML ที่จัดวางให้อ่านง่าย ตรวจ tree ค่า ลำดับ ความคิดเห็น และรูปแบบ scalar ให้ตรงต้นฉบับ
การเยื้องทำให้ YAML เล็กลงไหม
การเยื้องทำให้ YAML เล็กลงไหม
ลบความลับและข้อมูลส่วนบุคคลจากตัวอย่าง production แล้วเก็บต้นฉบับ
ผลล้มเหลวไม่ได้พิสูจน์กฎ parser เฉพาะ ต้องใช้หลักฐาน runtime ระบุตำแหน่ง
จะรักษา boolean และตัวเลขใน quote อย่างไร
จะรักษา boolean และตัวเลขใน quote อย่างไร
ใส่เอกสาร YAML ครบหรือ fragment ที่มีคำอธิบาย
ข้อผิดพลาดของ schema หรือแอปเป็นสัญญาอีกส่วน การจัดรูปแบบไม่เพิ่ม key ที่จำเป็นและไม่พิสูจน์ความปลอดภัยของ type
Frequently asked questions
การจัดรูปแบบตรวจ YAML schema หรือไม่
ไม่ การจัดรูปแบบจัดข้อความเท่านั้น ใช้ validator ของ JSON Schema OpenAPI Kubernetes หรือแอป
ชนิด scalar จะเปลี่ยนไหม
ควรรักษาการแทนค่าและเพิ่ม whitespace สำหรับการแสดงผล แต่ parser และ serializer อาจต่างกัน ตรวจเมื่อ type สำคัญ
ความคิดเห็นถูกเก็บไว้ไหม
ตัวอย่างเก็บความคิดเห็นไว้ใน view ควรตรวจด้วย engine จริงก่อนใช้ใน pipeline
จัด fragment ได้ไหม
ใช้เอกสารครบหรือ fragment ที่มีคำอธิบาย เพราะ fragment อาจพึ่ง anchor หรือการเยื้องของ parent
การเยื้องทำให้ YAML เล็กลงไหม
ไม่ whitespace เพื่ออ่านง่ายมักเพิ่มขนาด ใช้ minify แยกเมื่อ consumer รองรับ
จะรักษา boolean และตัวเลขใน quote อย่างไร
เก็บ quote เมื่อค่าหมายถึง string และตรวจการตีความตาม YAML version และ schema
YAML ผิดจะถูกซ่อมอัตโนมัติไหม
อย่าสันนิษฐานว่าซ่อมอัตโนมัติ แก้ source แล้วรัน parser และ checks ของแอป
หลังจัดรูปแบบควรทำอะไร
ตรวจ diff รัน parser และ schema checks แล้วทดสอบกับ consumer จริงเมื่อ alias หรือ whitespace มีผล