Trình kiểm tra JSON

Có rất nhiều định dạng “gần giống JSON” lưu hành (JSON5, JSONC, HJSON, các biến thể kiểu YAML). Bản thân đặc tả JSON thì nhỏ và nghiêm ngặt; trình kiểm tra này cho bạn biết tài liệu của mình có sống sót qua một trình phân tích nghiêm ngặt hay không, đó là thứ mà phần lớn các hệ thống phía sau thực sự chạy.

Những quy tắc khiến hầu hết mọi người vấp

Lỗi thường gặp và ý nghĩa của chúng

• “Unexpected token }”, bạn có một dấu phẩy thừa trước dấu ngoặc nhọn đóng.
• “Expected property name”, khóa không có dấu nháy hoặc bạn quên đặt dấu nháy quanh khóa đầu tiên.
• “Unexpected end of input”, một dấu { hoặc [ mở chưa được đóng; hãy đếm số ngoặc.
• “Bad control character”, một tab, ký tự xuống dòng hoặc byte điều khiển khác nằm trong một chuỗi literal. Hãy escape chúng thành \t, \n, v.v.
• “Duplicate key”, thực ra không phải lỗi theo đặc tả JSON (đặc tả nói NÊN duy nhất), nhưng nhiều trình kiểm tra cảnh báo. Trình kiểm tra báo nó như một thông báo, không phải lỗi nghiêm trọng.

Nếu bạn cần định dạng nới lỏng hơn

• JSON5 cho phép dấu phẩy thừa, comment và dấu nháy đơn. Dùng trình phân tích JSON5 nếu đó là định dạng đích của bạn.
• JSONC (JSON có comment) là thứ mà cấu hình VS Code dùng. Hãy loại bỏ comment trước khi phân tích nghiêm ngặt.
• YAML là một định dạng khác; đừng cho rằng nó “chỉ là JSON có thụt lề”.

Mẹo

• Kiểm tra trước khi commit. Một lỗi gõ trong package.json hay một cấu hình CI làm hỏng cả bản build cho tới khi có người nhận ra.
• In đẹp sau khi kiểm tra để diff dễ đọc khi review. Một tệp JSON một dòng thì hợp lệ nhưng review rất khổ.
• Với payload lớn, hãy kiểm tra theo luồng (ví dụ jq trên dòng lệnh). Phân tích trong trình duyệt đuối sức khi vượt vài MB.