Trình định dạng YAML

Make YAML structure easier to read

YAML thụt lề không đều có thể che giấu quan hệ cha con, mục danh sách và giá trị vô hướng. Công cụ này hiển thị cấu hình bằng dòng và thụt lề nhất quán.

Định dạng không chứng minh YAML tuân thủ schema hay hợp đồng ứng dụng. Hãy so sánh khóa, giá trị, thứ tự, dấu ngoặc và chú thích với nguồn.

Bắt đầu bằng mẫu nhỏ, giữ riêng nguồn, bản định dạng, kết quả parser và schema.

Với cấu hình sản xuất, xem diff vì tệp dễ đọc vẫn có thể chứa giá trị nguy hiểm, kiểu bất ngờ hoặc alias.

Formatting is not YAML validation

YAML biểu diễn mapping, sequence, scalar, chú thích, anchor, alias và ranh giới tài liệu bằng khoảng trắng và dấu câu.

Formatter sắp xếp cấu trúc nhưng không xác nhận JSON Schema, OpenAPI, Kubernetes hay quy tắc CI.

Chuỗi thường, chuỗi trích dẫn, boolean, null, số và block nhiều dòng có thể được parser diễn giải khác nhau.

Chú thích hữu ích cho người đọc nhưng thường không phải dữ liệu ứng dụng; kiểm tra serializer có giữ chúng không.

How to format YAML

1. Dán tài liệu YAML đầy đủ hoặc fragment có tài liệu.
2. Kiểm tra mapping, dấu danh sách, thụt lề, dấu ngoặc, chú thích và block.
3. So sánh ý nghĩa của khóa, giá trị, thứ tự, anchor, alias và marker với nguồn.
4. Chạy parser, schema validator, linter và test ứng dụng cần thiết.
5. Xóa bí mật và dữ liệu cá nhân khỏi mẫu sản xuất, giữ bản gốc.

Formatting method

• Đọc mapping, sequence,

  Đọc mapping, sequence, kiểu scalar, chú thích và ranh giới tài liệu từ YAML đầu vào.

• Thêm xuống dòng

  Thêm xuống dòng và thụt lề để khóa cha và giá trị con rõ ràng.

• Giữ chuỗi trích

  Giữ chuỗi trích dẫn, boolean, số, anchor, alias, block và chú thích theo nguồn.

Read the formatted result

Kết quả thành công là YAML được sắp xếp dễ đọc. Xác nhận cây, giá trị, thứ tự, chú thích và kiểu scalar giống nguồn.

Lỗi không tự chứng minh quy tắc parser cụ thể; cần bằng chứng runtime cho vị trí.

Lỗi schema hoặc ứng dụng là hợp đồng khác; định dạng không thêm khóa bắt buộc hay chứng minh an toàn kiểu.

Lỗi thường gặp

Coi thụt lề là kiểm tra schema có thể che giấu khóa thiếu hoặc kiểu sai.

Bỏ dấu ngoặc khỏi ngày, dấu hai chấm, boolean hoặc số có số 0 đầu có thể đổi diễn giải.

Sắp xếp list hoặc mapping vì hình thức có thể đổi cấu hình nhạy thứ tự.

Test fragment thiếu anchor, alias hoặc thụt lề cha sẽ khác file sản xuất.

Giới hạn và trường hợp đặc biệt

Chức năng này là định dạng YAML, không đảm bảo schema, linter, quản lý bí mật, biến đổi hay tương thích.

Chuyển scalar, khóa trùng, anchor, alias, block nhiều dòng và phiên bản YAML cần thử với parser đích.

Không dán cấu hình sản xuất bí mật nếu chính sách không cho phép.

Examples

Frequently asked questions

References

• YAML 1.2.2 specification
• Ali Hub YAML Formatter