Trình định dạng YAML

Trước và sau

Dữ liệu vào lộn xộn:

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

Đã định dạng (2 dấu cách, kiểu khối):

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

Tùy chọn định dạng

Quy tắc dấu nháy

Dấu nháy tối thiểu thường là điều bạn muốn: chuỗi được giữ nguyên không nháy trừ khi để trần sẽ không an toàn. Trình định dạng tự động thêm dấu nháy cho:

• Boolean kiểu cũ viết dưới dạng chuỗi: yes, no, on, off, y, n. YAML 1.2 đã đọc chúng là chuỗi, nhưng nhiều parser vẫn theo YAML 1.1, nơi no không nháy biến thành false. Trình định dạng luôn bọc chúng trong dấu nháy ở kết quả, nên lỗi Na Uy nổi tiếng (NO bị đọc thành false trong danh sách quốc gia) không thể cắn bất kỳ ai dùng file của bạn.
• Số viết dưới dạng chuỗi: '007', '3.14'. Không có nháy, chúng sẽ bị phân tích thành số nguyên hoặc số thực.
• Chuỗi chứa các ký tự như :, #, [, { hoặc bắt đầu bằng khoảng trắng, vì xuất trần sẽ làm thay đổi cấu trúc.

Những dọn dẹp ở mỗi lần chạy

• Khoảng trắng cuối dòng. Bị loại bỏ.
• Thụt lề lẫn lộn hoặc không đều. Được chuẩn hóa về độ rộng thụt lề bạn chọn.
• Dòng trống bên trong tập hợp. Bị loại bỏ.
• Tab trong thụt lề. YAML cấm tab; parser từ chối dữ liệu với thông báo lỗi rõ ràng chỉ đúng dòng, để bạn sửa thay vì phát hành một file mà các parser khác sẽ từ chối.

Chú thích, anchor và khóa gộp

Việc định dạng chuẩn hóa mô hình tài liệu, nên có vài giới hạn đáng biết trước khi commit:

• Chú thích bị xóa. Parser quy tài liệu về dữ liệu, nên chú thích # không sống sót qua định dạng. Hãy giữ một bản sao nếu chú thích quan trọng với bạn.
• Anchor và alias được phân giải. Các nút chia sẻ qua alias vẫn được chia sẻ, nhưng được xuất lại với tên tự sinh như &ref_0; tên anchor gốc không được giữ.
• Khóa gộp (<<:) được phân giải thành mapping thường với các giá trị đã gộp nằm đúng chỗ.

Stream nhiều tài liệu

Stream chứa nhiều tài liệu được hỗ trợ: mỗi tài liệu được định dạng độc lập rồi nối lại bằng dấu phân cách ---, tối đa 100 tài liệu mỗi lần chạy.