แปลง YAML เป็น JSON!

ป้อน YAML เพื่อแปลงเป็น JSON! รองรับ yml, Kubernetes, docker-compose
YAML
ผลลัพธ์
 

แปลง YAML เป็น JSON!

แปลงเอกสาร YAML (yml) เป็น JSON เพื่อดูโครงสร้างที่การย่อหน้าซ่อนไว้ และไทป์จริงที่แต่ละค่าถูกพาร์สออกมา anchor และ alias ถูกขยายเป็นค่าจริง และหลายเอกสารที่คั่นด้วย --- ถูกรวมเป็นอาร์เรย์

มีประโยชน์เป็นพิเศษในการจับความผิดพลาดคลาสสิกของ YAML: ค่าที่ไปติดกับ parent ผิดตัวเพราะขาดช่องว่างไปหนึ่งช่อง หรือ version: 1.10 ที่กลายเป็นตัวเลข 1.1 แบบเงียบ ๆ

วิธีใช้

  1. วาง docker-compose.yml, manifest ของ Kubernetes หรือไฟล์ workflow ลงในช่อง YAML หรือลากไฟล์มาวาง
  2. ข้อผิดพลาดทางไวยากรณ์แสดงในผลลัพธ์พร้อมหมายเลขบรรทัดและคอลัมน์ ให้ตรวจการย่อหน้าตรงจุดนั้นก่อน
  3. อ่าน JSON ใต้ ผลลัพธ์ เพื่อดูว่าแต่ละค่ากลายเป็นสตริง ตัวเลข หรือบูลีน แล้วคัดลอกถ้าต้องการ

ตัวอย่าง

อินพุต (YAML)
name: ci
on:
  push:
    branches: [main]
defaults: &node
  runs-on: ubuntu-latest
  timeout-minutes: 10
jobs:
  test: *node
เอาต์พุต (JSON)
{
  "name": "ci",
  "on": {
    "push": {
      "branches": [
        "main"
      ]
    }
  },
  "defaults": {
    "runs-on": "ubuntu-latest",
    "timeout-minutes": 10
  },
  "jobs": {
    "test": {
      "runs-on": "ubuntu-latest",
      "timeout-minutes": 10
    }
  }
}

คีย์ on: ของ GitHub Actions ยังเป็นคีย์สตริง "on" เพราะเครื่องมือนี้พาร์สตามกฎของ YAML 1.2 บล็อกที่นิยามด้วย anchor &node ถูกขยายแทนที่ *node

ฟีเจอร์ที่รองรับ

  • พาร์สด้วย core schema ของ YAML 1.2: yes, on และ off ยังเป็นสตริง และมีแค่ true/True/false ที่เป็นบูลีน
  • ~ และค่าว่างกลายเป็น null เลขฐานสิบหก 0x1F และฐานแปด 0o17 กลายเป็นตัวเลข
  • &anchors และ *aliases ถูก resolve เป็นค่าที่อ้างถึง
  • block scalar แบบ literal | และ folded > ถูกเปลี่ยนเป็นสตริงตามกฎการขึ้นบรรทัดของ YAML
  • หลายเอกสารที่คั่นด้วย --- กลายเป็นอาร์เรย์ JSON ส่วนเอกสารเดียวจะออกมาเป็นค่าของมันเอง
  • คีย์ที่ปรากฏสองครั้งใน mapping เดียวกันถูกรายงานเป็น error

กรณีการใช้งาน

ตรวจการย่อหน้าของ manifest ใน Kubernetes

ถ้า env ใต้ containers ย่อหน้าตื้นไปหนึ่งระดับ มันจะไปติดกับฟิลด์อื่นแบบเงียบ ๆ และคุณจะรู้ตัวก็ตอน apply ใน JSON วงเล็บปีกกาบอกได้ชัดว่ามันอยู่ในออบเจ็กต์ไหน

ใช้คอนฟิกจากโค้ด

สำหรับสคริปต์หรือ bundle ฝั่ง frontend ที่การเพิ่ม YAML parser ดูเกินจำเป็น ให้แปลงคอนฟิกครั้งเดียวแล้วใช้เป็น import config from './config.json'

ตรวจสเปก OpenAPI

เอกสาร OpenAPI ที่เขียนเป็น YAML จะ query ด้วย JSONPath หรือ jq ได้ง่ายขึ้นเมื่อแปลงแล้ว เช่น ดึง schema ที่ path เฉพาะออกมา

ข้อควรระวังและข้อจำกัด

  • merge key (<<: *defaults) ถูกนำมาใช้: คีย์ของ mapping ที่มี anchor ถูกคัดลอกเข้ามา และคีย์ที่เขียนข้าง << จะทับค่าเหล่านั้น parser ที่รองรับแค่ YAML 1.2 จะเก็บ << เป็นคีย์ธรรมดา ผลจึงอาจต่างจากเครื่องมือแบบนั้น
  • วันที่และเวลาอย่าง 2024-01-01 ยังเป็นสตริง ไม่กลายเป็นค่า Date
  • .inf และ .nan ไม่มีรูปแบบใน JSON จึงกลายเป็น null
  • คอมเมนต์นำไปใส่ใน JSON ไม่ได้และถูกตัดทิ้ง
  • PyYAML (YAML 1.1) อ่าน on และ yes เป็น true ผลจาก Python จึงอาจต่างออกไป

คำถามที่พบบ่อย

ทำไม on ของ GitHub Actions แสดงเป็น "on" แทน true?

ใน YAML 1.2 บูลีนมีแค่ true และ false ดังนั้น on เป็นสตริงธรรมดา ซึ่งก็เป็นวิธีที่ GitHub Actions อ่านคีย์นี้เช่นกัน PyYAML ของ Python ทำตาม 1.1 และเปลี่ยนเป็นคีย์ True จึงต้องระวังเมื่อพาร์ส workflow จากสคริปต์

version: 1.10 ออกมาเป็น 1.1

1.10 ที่ไม่มีเครื่องหมายคำพูดเป็นตัวเลขใน YAML และ 1.10 เท่ากับ 1.1 ถ้าจะเก็บเป็นสตริงเวอร์ชัน ให้ใส่เครื่องหมายคำพูดใน YAML ต้นฉบับเป็น "1.10"

ไฟล์ที่มีหลายเอกสารจะเป็นอย่างไร?

แต่ละเอกสารที่คั่นด้วย --- กลายเป็นสมาชิกของอาร์เรย์ตามลำดับ ไฟล์หลาย resource ที่ใช้กับ kubectl apply -f จึงได้อาร์เรย์ของ resource