Công cụ định dạng YAML

Định dạng YAML là gì?

Công cụ định dạng YAML chuẩn hóa thụt lề và khoảng cách của file YAML như manifest Kubernetes, workflow GitHub Actions hoặc file Docker Compose. Khác với các bộ chuyển đổi nạp rồi xuất lại dữ liệu, công cụ giữ nguyên chú thích, dấu phân tách tài liệu (---) và thứ tự khóa.

Cách sử dụng Định dạng YAML

1. Dán YAML vào ô nhập hoặc bấm Tải ví dụ.
2. Chọn Thụt lề (2 dấu cách là phổ biến với YAML).
3. Bấm Định dạng (kết quả cũng cập nhật khi bạn gõ).
4. Sao chép hoặc tải xuống YAML đã định dạng.

Ví dụ

a:   1
b:
      - x  # note

a: 1
b:
  - x # note

Khi nào nên dùng Định dạng YAML

Dùng để sửa thụt lề không nhất quán, làm gọn file CI/CD và Kubernetes hoặc kiểm tra YAML trước khi commit. YAML không cho phép dùng tab để thụt lề, nên không khuyến khích chọn Tab. Nếu chỉ cần kiểm tra cú pháp, hãy dùng Trình kiểm tra YAML.

Định dạng YAML hoạt động như thế nào

Đầu vào trước tiên được nạp bằng js-yaml để phát hiện lỗi (kể cả khóa trùng) với dòng và cột chính xác. Sau đó nó được in ra bằng plugin YAML của Prettier, plugin này làm việc trên cây cú pháp cụ thể, nên chú thích, anchor, chuỗi nhiều dòng và flow collection được giữ nguyên trong khi thụt lề và khoảng cách được chuẩn hóa.

Các Trường Hợp Sử Dụng Phổ Biến

• ✓ Chuẩn hóa file values của Kubernetes hoặc Helm
• ✓ Làm gọn workflow GitHub Actions
• ✓ Sửa thụt lề lẫn lộn trong docker-compose.yml
• ✓ Định dạng ví dụ YAML cho tài liệu

Câu Hỏi Thường Gặp

Khám phá thêm danh mục