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.

Schema Aggrega Wasm Linter Socket

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 của schema: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json

Các dạng dữ liệu truyền mà socket linter tiếp nhận (LinterInput) và phát ra (LinterOutput). Linter chạy vào thời điểm xuất bản trên một cặp thực thể gồm phiên bản trước và phiên bản đề xuất (quy tắc tiến hóa schema) và vào thời điểm lint workspace trên từng thực thể riêng lẻ (các quy tắc cấu trúc theo từng quy tắc). Một plugin Wasm được phát hành chứa nhiều quy tắc; plugin chọn quy tắc cần chạy theo LinterInput.rule_id. Schema này là nguồn duy nhất của cả hai dạng dữ liệu truyền: các kiểu payload Go, Rust và TypeScript được sinh từ nó vào gói plugin-ABI dùng chung, và mỗi bộ kit plugin tái xuất các kiểu được sinh đó thay vì tự khai báo bản sao riêng.

Một trong các dạng sau

  • LinterInput
  • LinterOutput

Định nghĩa

LinterInput

Payload mà host chuyển cho plugin publishing-linter trong mỗi lần gọi. rule_id chọn quy tắc mà plugin điều phối tới. entity_kind xác định loại thực thể đang được lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed mang cấu trúc thực thể đã được phân tích cú pháp đang được phân loại (host phân tích YAML thành JSON trước khi gửi; plugin không bao giờ thấy byte thô). previous mang thực thể phiên bản trước đã được phân tích cú pháp cho quy tắc schema-evolution; bị bỏ qua khi không áp dụng. implemented_component mang một thực thể liên quan thuộc loại khác — Component mà một Recipe được lint hiện thực hóa — cho các quy tắc so sánh một thực thể với một hợp đồng do thực thể khác khai báo; bị bỏ qua khi không áp dụng. release và components mang phần còn lại của một Release cho quy tắc đọc toàn bộ một Release — khi đó proposed là Aggregate mà Release triển khai, release là chính Release đó, và components là Component mà mỗi phiên bản component của Aggregate là một thể hiện của nó; cả hai đều bị bỏ qua trên mọi đầu vào khác. policies mang cấu hình kỷ luật xuất bản theo từng workspace mà quy tắc tham chiếu.

Thuộc tínhLoạiBắt buộcMô tả
rule_idstringcóQuy tắc mà plugin nên điều phối tới, được đặt tên bằng rule id của nó — cùng định danh kebab-case mà phát hiện kết quả mang trong rule_id, để một quy tắc bị chặn hoặc được báo cáo được gọi tên giống nhau trên mọi bề mặt. Tập được nhận diện là bất cứ gì plugin được phát hành điều phối; một rule id mà plugin không nhận diện sẽ tạo ra một phát hiện ‘unknown_rule’ thay vì lặng lẽ cho qua.
entity_kindstring (enum)cóLoại thực thể mà các giá trị proposed/previous mã hóa. Cách phân loại của quy tắc schema-evolution thay đổi theo từng loại; các quy tắc cấu trúc giới hạn ở các loại cụ thể. Giá trị cho phép: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate"
proposedobjectcóCấu trúc đã phân tích cú pháp của thực thể đang được phân loại. Host chuyển YAML thành JSON trước khi gửi, nên plugin nhận một giá trị đã có cấu trúc và không bao giờ thấy byte thô. Trên đầu vào của quy tắc đọc toàn bộ một Release, đây là Aggregate mà Release đó triển khai. Trên mọi đầu vào, mọi giá trị tham số đều bị loại bỏ trước khi thực thể được chuyển giao, vì giá trị của một tham số có thể chính là thông tin xác thực, nên không giá trị tham số nào đến được plugin linter qua trường này. Một Aggregate giữ lại các khai báo spec.parameters của nó, mỗi khai báo chỉ chứa các khóa mà schema Aggregate chấp nhận trên một khai báo tham số ngoài default, và mọi khai báo lồng dưới properties, items và valuesType cũng tuân theo điều đó: một default bị loại bỏ chứ không được thay thế, nên plugin không thể biết một khai báo có đưa ra default hay không, và một khóa mà schema không chấp nhận ở đó sẽ bị loại bỏ cùng mọi thứ nó chứa. Khối parameters của mỗi module dưới spec.aggregates, vốn mang các giá trị được truyền cho module đó, bị loại bỏ toàn bộ, cũng như spec.parameters trên một thực thể thuộc bất kỳ loại nào khác. Văn bản template đọc một tham số được giữ nguyên như đã viết.
previousobjectkhôngCấu trúc đã phân tích cú pháp của thực thể phiên bản trước, dành cho các quy tắc thực hiện so sánh theo cặp (schema-evolution), với các giá trị tham số bị loại bỏ đúng như cách chúng bị loại bỏ khỏi proposed. Bị bỏ qua khi quy tắc không cần tham chiếu phiên bản trước (ví dụ: lần xuất bản đầu tiên, các quy tắc chỉ về cấu trúc).
implemented_componentobjectkhôngCấu trúc đã phân tích cú pháp của Component mà một Recipe được lint nêu trong spec.implements, do host phân giải. Đây là một thực thể liên quan thuộc loại KHÁC với thực thể đang được lint, đó là điểm phân biệt nó với previous: previous mang một phiên bản khác của cùng thực thể, còn trường này mang Component có hợp đồng đầu ra đã khai báo mà Recipe hiện thực hóa. Host phân giải nó qua cùng phép tra cứu catalog mà một bản build sử dụng, theo khóa là tên của Component, nên cả ba dạng ghim mà spec.implements chấp nhận (không phiên bản, chính xác, khoảng tương thích major) đều đến cùng một mục. Bị bỏ qua khi thực thể được lint không phải là Recipe, khi nó không nêu Component nào, hoặc khi không có Component nào mang tên đó truy cập được trong các thư mục catalog của workspace. Giá trị vắng mặt nghĩa là không thể so sánh, chứ không phải hợp đồng rỗng: một quy tắc đọc trường này không phát ra phát hiện nào khi nó vắng mặt.
releaseobjectkhôngCấu trúc đã phân tích cú pháp của Release mà một lần lint phạm vi release nêu tên, với chuỗi extends được gộp vào, để một Release con mang những gì nó kế thừa từ Release cơ sở. Host chuyển nó từ YAML sang JSON giống như với proposed. Khối spec.parameters của nó chứa các giá trị đáp ứng các tham số của Aggregate, nên nó bị loại bỏ toàn bộ trước khi Release được chuyển giao: giá trị của một tham số có thể chính là thông tin xác thực, không quy tắc nào đọc khối này, và vì vậy không giá trị tham số nào đến được plugin linter qua trường này. Chỉ có mặt trên đầu vào của quy tắc đọc toàn bộ một Release, khi đó proposed là Aggregate mà Release này triển khai, với các giá trị tham số bị loại bỏ như mô tả ở proposed; bị bỏ qua trên mọi đầu vào khác.
componentsmap của objectkhôngComponent mà mỗi phiên bản component của Aggregate là một thể hiện của nó, theo khóa là tên phiên bản mà Aggregate đặt cho nó, cũng là khóa mà các map components của chính Aggregate và Release sử dụng. Mỗi giá trị là Component mà type của phiên bản phân giải tới, với mọi chuỗi extends được gộp vào, được chuyển sang JSON như implemented_component. Một phiên bản có Component không truy cập được trong các thư mục catalog của workspace sẽ vắng mặt, và quy tắc hiểu sự vắng mặt đó là không khả dụng chứ không phải là một Component không khai báo gì. Chỉ có mặt cùng với release, trên đầu vào của quy tắc đọc toàn bộ một Release; bị bỏ qua trên mọi đầu vào khác.
source_pathstringkhôngĐường dẫn hệ thống tệp mà thực thể được nạp từ đó. Được điền bởi các trình gọi phía host duyệt hệ thống tệp catalog; được dùng bởi các quy tắc nhận biết đường dẫn (ví dụ: category-matches-directory). Bị bỏ qua khi trình gọi không có ngữ cảnh đường dẫn.
policiesPolicieskhôngCấu hình kỷ luật xuất bản theo từng workspace mà quy tắc tham chiếu, được mang dưới dạng một đối tượng Policies do host lắp ráp từ cấu hình workspace và mọi ghi đè từ dòng lệnh.

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

LinterOutput

Dạng phản hồi mà plugin publishing-linter phát ra. findings mang một mục cho mỗi lần gọi quy tắc tạo ra kết quả. Quy tắc schema-evolution phát ra đúng một phát hiện (kết luận phân loại); các quy tắc cấu trúc có thể phát ra không phát hiện nào (không có vi phạm) hoặc nhiều phát hiện (một cho mỗi vi phạm).

Thuộc tínhLoạiBắt buộcMô tả
findingsDiagnostic[]cóCác phát hiện theo từng quy tắc do lần gọi plugin tạo ra, theo thứ tự plugin phát ra.
errorstringkhôngMột thông điệp lỗi được đặt khi guest đã chạy nhưng không thể hoàn tất thao tác; vắng mặt khi thành công. Nó khác với mọi chẩn đoán mà đầu ra mang theo: chẩn đoán báo cáo các vấn đề phát hiện trong một lần chạy vẫn tạo ra kết quả, còn error báo cáo rằng bản thân thao tác đã không hoàn tất. Host hiển thị một error có mặt như một lần gọi plugin thất bại.

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

Policies

Cấu hình kỷ luật xuất bản theo từng workspace mà bộ quy tắc tham chiếu, được host tập hợp từ các thiết lập kỷ luật xuất bản trong cấu hình workspace và mọi ghi đè từ dòng lệnh. Schema này là hợp đồng cho cấu trúc đó. Khi một trường bị bỏ qua, mỗi cờ mặc định là false, và host chỉ ghi những trường có giá trị khác mặc định.

Thuộc tínhLoạiBắt buộcMô tả
allow_dynamic_refsbooleankhôngKhi là true, việc sử dụng $dynamicAnchor / $dynamicRef trong các mục SchemaLibrary được cho phép (vô hiệu hóa quy tắc dynamic-refs). Mặc định là false.
allow_id_overridesbooleankhôngKhi là true, việc ghi đè $id trong các mục SchemaLibrary được cho phép (vô hiệu hóa quy tắc id-overrides). Mặc định là false.
allow_direct_x_aggrega_extensionsbooleankhôngKhi là true, việc viết trực tiếp x-aggrega-selector / x-aggrega-inject được cho phép (vô hiệu hóa quy tắc x-aggrega-discouragement). Mặc định là false.
allow_aggrega_ai_prefixbooleankhôngKhi là true, quy tắc annotation-prefix bị vô hiệu hóa hoàn toàn (cả kiểm tra aggrega.ai/ trần lẫn kiểm tra feature.aggrega.ai/ có điều kiện theo loại). Mặc định là false.
allow_nonstandard_namesbooleankhôngKhi là true, các vi phạm name-shape được cho phép (vô hiệu hóa quy tắc name-shape). Mặc định là false.
allow_category_mismatchesbooleankhôngKhi là true, ẩn các phát hiện của quy tắc category-matches-directory. Quy ước của catalog chuẩn yêu cầu các Components nằm dưới core// khai báo component.aggrega.ai/category={category} khớp với phân đoạn thư mục, trong đó {category} là một trong 15 giá trị thuộc tập đóng. Các workspace có ngoại lệ lâu dài chính đáng sẽ chọn không áp dụng tại đây. Mặc định là false.
allow_undeclared_recipe_providesbooleankhôngKhi là true, ẩn các phát hiện của quy tắc provides-declared-by-component. Quy tắc đó báo cáo từng khóa mà một Recipe xuất bản trong spec.provides nhưng Component được nêu tên trong spec.implements của nó không khai báo trong trụ cột provides của spec.schema. Việc xuất bản vượt ngoài hợp đồng đã khai báo vẫn được chấp nhận khi build, nên phát hiện này chỉ mang tính khuyến nghị; một workspace có các Recipes cố ý xuất bản những khóa mà Component của chúng không khai báo có thể chọn không áp dụng tại đây. Mặc định là false.
allow_connection_credential_mismatchesbooleankhôngKhi là true, ẩn các phát hiện của quy tắc connection-credential-matches-target-key. Quy tắc đó đọc toàn bộ một Release và, với mỗi kết nối có đích khai báo khóa mà nó yêu cầu từ bên gọi, so sánh thông tin xác thực mà kết nối xuất trình với khóa mà đích nắm giữ: nó báo cáo khi hai đầu nêu tên các secret khác nhau, và khi một khóa chỉ được khai báo ở một đầu. Sự khớp nhau giữa hai đầu là một quy ước của catalog chứ không phải điều mà quá trình build kiểm tra, nên phát hiện này chỉ mang tính khuyến nghị; một workspace có hai đầu cố ý khác nhau có thể chọn không áp dụng tại đây. Mặc định là false.

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