Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Lược đồ chẩn đoán dùng chung của Wasm-plugin trong Aggrega

Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.

Id lược đồ: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json

Hình dạng chẩn đoán duy nhất mà mọi socket Wasm dùng chung. Một plugin báo cáo một mục cho mỗi vấn đề nó nêu ra; host hiển thị mục đó. Hình dạng này là một tập bao: mỗi socket điền tập con mà nó dùng và bỏ qua phần còn lại, nên một chẩn đoán từ bất kỳ socket nào cũng là một cấu trúc thống nhất. severity là một trong ba giá trị mà mọi socket dùng chung — halt, warn hoặc info — nên một chẩn đoán mang cùng một ý nghĩa dù socket nào nêu ra nó.

Kiểu cấp cao nhất: object

Định nghĩa

Diagnostic

Một vấn đề mà một bộ phát chẩn đoán nêu ra: một mức độ nghiêm trọng, một thông điệp con người đọc được, một vị trí tùy chọn và các trường tùy chọn riêng của bộ phát. Một bộ phát là một socket của Wasm plugin hoặc chính trình biên dịch — cả hai đều báo cáo theo một hình dạng này, nên người đọc diễn giải một mục theo cùng một cách dù bên nào nêu ra nó. Mỗi bên điền tập con mà nó dùng và bỏ qua phần còn lại: một trình phân tích cú pháp đặt một khoảng vị trí, một import đặt code và source_ref, một linter xuất bản đặt rule_id và classification, một phán quyết quản trị đặt severity và message của kết quả build và có thể thêm bất kỳ trường nào trong code, rule_id, classification, source_ref, location và suggest, còn một khuyến cáo khi render đặt code, source_ref và một location có cấu trúc.

Thuộc tínhLoạiBắt buộcMô tả
severitystring (enum)cóMức độ nghiêm trọng của chẩn đoán, lấy từ một tập đóng mà mọi socket dùng chung. halt dừng build và chỉ ra điều cần sửa. warn hiển thị kèm theo một build vẫn hoàn tất. info ghi lại quan sát và giữ nguyên kết quả build. Mọi bộ phát đều báo cáo từ tập này, nên người đọc diễn giải một mức độ nghiêm trọng theo cùng một cách dù bên nào nêu ra nó. Giá trị cho phép: "halt", "warn", "info"
messagestringcóVăn bản chẩn đoán con người đọc được.
codestringkhôngMột mã tùy chọn, ổn định, máy có thể so khớp cho chẩn đoán, độc lập với thông điệp con người đọc được. Vắng mặt khi bộ phát không gán mã. Một mã có thể đến từ một socket plugin hoặc từ các khuyến cáo của chính trình biên dịch, vốn đặt một mã trên mọi mục chúng nêu ra.
rule_idstringkhôngĐịnh danh của quy tắc đã tạo ra chẩn đoán, khi bộ phát dựa trên quy tắc (một linter xuất bản). Vắng mặt trong trường hợp khác.
classificationstring (enum)khôngMột phân loại mức ảnh hưởng theo phiên bản ngữ nghĩa mà chẩn đoán mang theo, khi quy tắc phát gán một phân loại (một quy tắc tiến hóa lược đồ). Vắng mặt với các chẩn đoán không mang phân loại. Giá trị cho phép: "PATCH", "MINOR", "MAJOR"
source_refstringkhôngMột tham chiếu không trong suốt tới phần tử nguồn mà chẩn đoán liên quan (ví dụ định danh của một nút nguồn mà một import không thể phân giải). Vắng mặt khi chẩn đoán không tham chiếu phần tử nguồn cụ thể nào.
locationLocationkhôngNơi chẩn đoán trỏ tới, khi bộ phát có thể định vị vấn đề. Một trình phân tích cú pháp điền khoảng byte; một renderer điền vị trí có cấu trúc trong một tài liệu nguồn. Vắng mặt khi chẩn đoán không có vị trí.
suggeststringkhôngMột gợi ý khắc phục tùy chọn mà bộ phát đưa ra kèm theo chẩn đoán. Vắng mặt khi không có gợi ý nào.

Không cho phép thuộc tính bổ sung.

Location

Nơi một chẩn đoán trỏ tới. Nó mang một bộ định vị hợp nhất phục vụ cả vị trí chính xác đến từng byte trong văn bản nguồn thô (một trình phân tích cú pháp điền span) lẫn vị trí có cấu trúc trong một tài liệu nguồn (một renderer điền key_path, uri, line và kind), và nêu tên instance của build mà chẩn đoán liên quan, khi có (instance). Mọi trường đều tùy chọn; một socket điền dạng biểu diễn mà nó có thể tạo ra và bỏ qua phần còn lại.

Thuộc tínhLoạiBắt buộcMô tả
spanSpankhôngKhoảng byte nguồn thô mà chẩn đoán định vị, khi bộ phát phân tích nguồn và có thể ghim vấn đề vào một dải byte (một trình phân tích cú pháp). Vắng mặt trong trường hợp khác.
key_pathstringkhôngMột đường dẫn phân tách bằng dấu chấm tới phần tử gây lỗi trong một tài liệu nguồn có cấu trúc, khi bộ phát định vị vấn đề theo cấu trúc (một renderer). Vắng mặt trong trường hợp khác.
uristringkhôngMột định danh cho artifact nguồn mà chẩn đoán liên quan, khi bộ phát biết nó (một renderer). Vắng mặt trong trường hợp khác. Nó không bao giờ nêu tên một instance của build; instance mang thông tin đó.
lineintegerkhôngMột số dòng trong tài liệu nguồn có cấu trúc, khác với dòng và cột theo byte thô mà span mang. Có mặt khi bộ phát biết một dòng của tài liệu (một renderer). Vắng mặt trong trường hợp khác.
kindstringkhôngMột chuỗi mở gọi tên bề mặt nguồn mà vị trí tham chiếu tới, khi bộ phát phân biệt các bề mặt (một renderer). Vắng mặt trong trường hợp khác.
instancestringkhôngInstance của build mà chẩn đoán liên quan, theo định danh mà build gán cho nó: một component theo tên mà Aggregate khai báo nó, một component do một module đóng góp theo đường dẫn phân tách bằng dấu chấm qua module đó, một component do build suy ra theo định danh mà build ghép cho nó, và một module theo đường dẫn riêng của nó. Có mặt khi chẩn đoán nói về một instance; vắng mặt trong trường hợp khác.

Không cho phép thuộc tính bổ sung.

Span

Một khoảng của các byte nguồn gốc: các offset byte là vị trí chính, chính xác, còn số dòng và số cột đi kèm để chẩn đoán dễ đọc với con người.

Thuộc tínhLoạiBắt buộcMô tả
start_offsetintegercóOffset byte của byte đầu tiên của khoảng trong nguồn gốc, đánh số từ 0.
end_offsetintegercóOffset byte ngay sau byte cuối cùng của khoảng trong nguồn gốc, nên end_offset trừ start_offset là độ dài của khoảng tính bằng byte.
start_lineintegercóSố dòng nơi khoảng bắt đầu, đánh số từ 1, để chẩn đoán dễ đọc với con người.
start_columnintegercóSố cột nơi khoảng bắt đầu, đánh số từ 1, để chẩn đoán dễ đọc với con người.
end_lineintegercóSố dòng nơi khoảng kết thúc, đánh số từ 1, để chẩn đoán dễ đọc với con người.
end_columnintegercóSố cột nơi khoảng kết thúc, đánh số từ 1, để chẩn đoán dễ đọc với con người.

Không cho phép thuộc tính bổ sung.