Trình kiểm tra DESIGN.md

Phần frontmatter YAML, màu primary bắt buộc, việc màu được viết theo một định dạng màu (hex, rgb, hsl, oklch, tên màu và tương tự), cỡ chữ và bo góc tính bằng px, em hoặc rem, thuộc tính kiểu chữ, thuộc tính component và các tham chiếu token của chúng (kể cả tham chiếu không đặt trong dấu nháy, vốn YAML không đọc là văn bản), danh sách omitted, các mục bị trùng hoặc sai thứ tự, và độ tương phản giữa màu chữ và màu nền của từng component so với mức tối thiểu WCAG AA là 4.5:1. Lỗi khiến tệp không hợp lệ; cảnh báo chỉ ra những điểm nên sửa.

Không. Việc kiểm tra chạy hoàn toàn trong trình duyệt của bạn: văn bản bạn dán hoặc tệp bạn chọn không bao giờ được gửi tới máy chủ của chúng tôi. Yêu cầu duy nhất mà bản xem trước gửi đi là để tải stylesheet font: máy chủ của chúng tôi lấy chúng từ Google Fonts, và các yêu cầu này chỉ mang tên họ font từ các token kiểu chữ của bạn.

Định dạng DESIGN.md của Google, như Stitch sử dụng và được công bố trong kho google-labs-code/design.md. Trình kiểm tra áp dụng cùng các quy tắc mà Design Extractor dùng để kiểm tra mọi tệp DESIGN.md nó tạo ra, cộng thêm bước kiểm tra độ tương phản cho màu của component.

Một tham chiếu như "{colors.brand}" phải trỏ tới một token có trong frontmatter, ở đây là mục brand bên dưới colors. Hãy thêm token còn thiếu hoặc trỏ tham chiếu tới một token đã có. Luôn đặt tham chiếu trong dấu nháy: YAML đọc {colors.brand} không có dấu nháy là một mapping, không phải văn bản.

Có. Công cụ dòng lệnh mã nguồn mở của Google kiểm tra tệp ngay trong pipeline của bạn: chạy npx @google/design.md lint DESIGN.md. Công cụ in ra báo cáo JSON và thoát với mã 1 khi tìm thấy lỗi, nên job sẽ thất bại nếu tệp bị hỏng. Bộ quy tắc của nó trùng một phần với trang này nhưng một số mức độ nghiêm trọng khác nhau.