Trợ giúp

YAML validator: soát cú pháp YAML ngay khi bạn gõ

Dán YAML của bạn vào, và YAML validator này soát nó ngay khi bạn gõ. Mỗi lỗi cú pháp được giải thích bằng lời đơn giản, kèm dòng và cột. Công cụ phát hiện thụt lề bằng phím Tab, khóa trùng nhau, dấu nháy và ngoặc chưa đóng, cũng như khoảng trắng không ngắt dòng vô hình trông giống thụt lề nhưng không phải. Đây là một YAML validator online chạy ngay trong trình duyệt của bạn, nên YAML không bao giờ được tải lên.


Cách validate YAML online từng bước

Dán hoặc gõ YAML của bạn vào ô YAML. Không có nút xác nhận: văn bản được soát trực tiếp.

  1. Văn bản dán vào được soát ngay lập tức. Khi bạn gõ, việc soát chạy sau khoảng một phần tư giây kể từ phím cuối cùng, lâu hơn một chút với văn bản rất lớn. Kết quả trước vẫn hiện mờ cho đến khi có kết quả mới.
  2. Đọc khung bên dưới trình soạn thảo. Khung xanh YAML hợp lệ nghĩa là cú pháp đúng. Khung đỏ “YAML không hợp lệ” (hoặc “YAML không hợp lệ: N vấn đề”) liệt kê những gì sai.
  3. Mỗi vấn đề có một câu giải thích, “Dòng N, cột M” và một đoạn trích của dòng kèm số dòng: hai dòng phía trên, một dòng phía dưới và dấu ^ dưới cột.
  4. Chọn Hiện trong trình soạn thảo để chọn dòng đó trong ô, sửa lại rồi xem khung chuyển sang màu xanh.

Chỉ lỗi cú pháp đầu tiên của mỗi tài liệu được báo. Các lỗi sau đó thường là hệ quả, chẳng hạn một dấu nháy bị thiếu nuốt mất các dòng bên dưới. Khóa trùng nhau và bí danh chưa định nghĩa luôn được liệt kê đầy đủ. Tối đa 20 vấn đề được hiển thị.

Các lỗi cú pháp phổ biến và cách sửa

Mỗi lỗi được giải thích bằng một câu thay vì thông báo thô của trình phân tích cú pháp. Đây là những lỗi gặp nhiều nhất:

Ý nghĩa các thông báo của công cụ khác

Bạn đến đây từ một thông báo trong terminal hoặc log CI? Dưới đây là cách các cách diễn đạt thường gặp tương ứng với những gì trình này báo. Dán cùng tệp đó vào và nó sẽ chỉ ra dòng.

Cách diễn đạt khác nhau giữa các trình phân tích cú pháp (PyYAML, js-yaml, Ruby, Go, trình nạp của Home Assistant và ESPHome), và trình phân tích thường báo một dòng nằm dưới lỗi thật. Công cụ này chỉ vào dòng mà nó có thể hiển thị cho bạn.

Phím Tab và ký tự vô hình

Hai lỗi khó phát hiện nhất trong YAML là những lỗi bạn không nhìn thấy. Công cụ này làm chúng hiện ra.

Ví dụ: trong một tệp có server: và bên dưới là port: 8080, dòng cuối host: example.com bắt đầu bằng hai khoảng trắng không ngắt dòng thay vì hai khoảng trắng thường. YAML đọc nó như một khóa cấp cao nhất riêng, và host không phải con của server. Khung vàng nêu tên ký tự và dòng đó.

Định dạng YAML và sao chép kết quả

Bật công tắc Định dạng YAML phía trên ô nhập. Mặc định công tắc này tắt. Khi văn bản hợp lệ, khối YAML đã định dạng xuất hiện cùng nút Sao chép ở phía trên, nút này đổi thành Đã sao chép sau khi sao chép. Việc định dạng có thể đoán trước:

Chỉ YAML hợp lệ mới được định dạng, nên nó không sửa được tệp bị hỏng: hãy sửa lỗi trước. Kết quả rất dài được hiển thị bị cắt sau 600.000 ký tự, và Sao chép vẫn sao chép tất cả.

YAML lint check online: dùng cho việc gì, kích thước và giới hạn

Là một công cụ YAML lint online, việc soát là như nhau dù YAML dùng cho việc gì. Nó dùng được cho workflow GitHub Actions, docker-compose.yml, manifest Kubernetes và giá trị Helm, tệp OpenAPI, playbook Ansible, cấu hình Home Assistant, mẫu CloudFormation và cấu hình mkdocs. Hãy dán tệp trước khi commit và lỗi cú pháp hiện ra mà không cần chờ một lần chạy CI. Tệp có nhiều tài liệu phân tách bằng --- được soát từng tài liệu một, và khung xanh cho biết đã tìm thấy bao nhiêu. Neo (&tên) và bí danh (*tên) được soát. Các thẻ tùy chỉnh như !Ref, !Sub, !GetAtt của CloudFormation hay !reference của GitLab được chấp nhận là hợp lệ.

Việc soát chạy trong một Web Worker ngay trong trình duyệt của bạn. Các tệp cấu hình, CI và Kubernetes thông thường được soát trong chớp mắt. Giới hạn là 5.000.000 ký tự, và văn bản gần mức này mất vài giây và tốn nhiều bộ nhớ. Vượt giới hạn, bạn sẽ được nhắc dán một đoạn nhỏ hơn.

Chỉ cú pháp YAML được soát. Công cụ không biết một chương trình cụ thể mong đợi gì, nên các trường của Kubernetes, khóa của GitHub Actions hay Docker Compose và quy tắc JSON Schema không được soát, và tên khóa viết sai chính tả vẫn qua. Công cụ theo YAML 1.2, nên các từ yes, no, on và off của YAML 1.1 là văn bản thường và không bao giờ bị đánh giá. Nó không chạy, không tải về và không nạp gì cả, và một ký tự xuống dòng kiểu Mac cũ đứng một mình không được coi là ngắt dòng.

Bạn làm việc với định dạng khác? Hãy chỉnh gọn và soát JSON bằng Định dạng JSON, đối chiếu với schema bằng Trình kiểm tra JSON Schema, hoặc soát markup bằng Kiểm tra XML. Cần tìm một mẫu trong cấu hình? Hãy thử trong Kiểm tra Regex.


Câu hỏi thường gặp

Làm sao để validate YAML online?

Dán YAML của bạn vào ô “YAML”. Văn bản được soát khi bạn dán hoặc gõ, nên không có nút nào để bấm. Khung xanh “YAML hợp lệ” nghĩa là cú pháp đúng. Khung đỏ “YAML không hợp lệ” nêu từng vấn đề bằng lời đơn giản, kèm “Dòng N, cột M” và một đoạn trích của dòng.

Vì sao YAML nói không được dùng phím Tab để thụt lề?

YAML chỉ cho phép khoảng trắng để thụt lề, và một Tab ở đầu dòng là lỗi cú pháp. Trình soạn thảo thường chèn Tab khi bạn nhấn phím Tab, hoặc Tab đi kèm văn bản được dán. Công cụ báo rằng dòng đó được thụt lề bằng Tab. Hãy thay Tab bằng khoảng trắng.

“mapping values are not allowed here” trong YAML nghĩa là gì?

Thường là có dấu hai chấm thứ hai trên một dòng, như “a: b: c”, hoặc giá trị không có dấu nháy chứa dấu hai chấm. Cũng có thể là dòng thụt lề dưới một khóa đã có giá trị. Hãy đặt giá trị trong dấu nháy hoặc viết cặp bên trong ở dòng riêng có thụt lề.

“did not find expected key” trong YAML nghĩa là gì?

Một dòng không thẳng hàng với các khóa khác trong cùng mapping. Thường là một khóa có nhiều hơn hoặc ít hơn một khoảng trắng so với các khóa bên cạnh. Hãy cho mọi khóa cùng cấp cùng một mức thụt lề. Công cụ báo điều này là dòng không thẳng hàng với các khóa khác.

Làm sao tìm khóa trùng nhau trong YAML?

Dán văn bản vào. Các khóa trùng nhau trong cùng một mapping luôn được liệt kê đầy đủ, mỗi khóa kèm dòng và cột. Thường là một khối được sao chép để lại khóa lặp. Hãy gộp các mục lại hoặc xóa bản trùng.

Vì sao tệp YAML hợp lệ lại hiện “Hợp lệ, nhưng hãy kiểm tra các dòng sau”?

Một dòng bắt đầu bằng khoảng trắng vô hình, ví dụ khoảng trắng không ngắt dòng. YAML đọc nó như một phần của khóa, nên dòng đó thực ra không được thụt lề dù tệp hợp lệ. Khung vàng nêu tên ký tự và dòng đó. Hãy xóa nó và gõ khoảng trắng thường.

Tôi có thể soát tệp YAML của GitHub Actions, Docker Compose hoặc Kubernetes ở đây không?

Được, việc soát cú pháp là như nhau với mọi YAML. Nó dùng được cho workflow, docker-compose.yml, manifest Kubernetes và nhiều tệp khác. Chỉ cú pháp được soát: công cụ không biết mỗi chương trình mong đợi khóa nào, và tên khóa viết sai chính tả vẫn qua.

Tệp YAML lớn đến mức nào thì soát được?

Giới hạn là 5.000.000 ký tự. Các tệp cấu hình thông thường được soát trong chớp mắt, còn văn bản gần mức giới hạn mất vài giây và tốn nhiều bộ nhớ. Vượt giới hạn, bạn sẽ được nhắc dán một đoạn nhỏ hơn.