Schemat gniazda lintera Aggrega Wasm
Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.
Identyfikator schematu: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json
Kształty komunikatów, które gniazdo lintera przyjmuje (LinterInput) i emituje (LinterOutput). Linter działa w czasie publikacji na parze encji złożonej z poprzedniej i proponowanej wersji (reguła ewolucji schematu) oraz w czasie lintowania przestrzeni roboczej na pojedynczych encjach (reguły strukturalne dla poszczególnych reguł). Jeden dostarczany plugin Wasm obsługuje wiele reguł; plugin wybiera regułę do uruchomienia na podstawie LinterInput.rule_id. Ten schemat jest jedynym źródłem obu kształtów komunikatów: typy ładunków dla Go, Rust i TypeScript są z niego generowane do współdzielonego pakietu plugin-ABI, a każdy zestaw narzędzi dla pluginów reeksportuje te wygenerowane typy zamiast deklarować własną kopię.
Jeden z następujących kształtów
LinterInputLinterOutput
Definicje
LinterInput
Ładunek, który host przekazuje pluginowi publishing-linter przy każdym wywołaniu. rule_id wybiera regułę, do której plugin kieruje wywołanie. entity_kind określa rodzaj sprawdzanej encji (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed przenosi sparsowaną strukturę klasyfikowanej encji (host parsuje YAML do JSON przed wysłaniem; plugin nigdy nie widzi surowych bajtów). previous przenosi sparsowaną encję w poprzedniej wersji dla reguły schema-evolution; pomijane, gdy nie ma zastosowania. implemented_component przenosi powiązaną encję innego rodzaju — encję Component realizowaną przez sprawdzaną encję Recipe — dla reguł porównujących encję z kontraktem deklarowanym przez inną encję; pomijane, gdy nie ma zastosowania. release i components przenoszą resztę encji Release dla reguły, która odczytuje ją w całości — proposed jest wtedy encją Aggregate wdrażaną przez Release, release tą encją Release, a components encją Component, której instancją jest każda instancja komponentu w encji Aggregate; oba pola są pomijane w każdym innym wejściu. policies przenosi konfigurację dyscypliny publikowania dla danego obszaru roboczego, z której korzysta reguła.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
rule_id | string | tak | Reguła, do której plugin powinien skierować wywołanie, nazwana swoim identyfikatorem reguły — tym samym identyfikatorem w stylu kebab-case, który wynikowe zgłoszenie przenosi w rule_id, dzięki czemu wyciszona lub zgłoszona reguła ma tę samą nazwę na każdej powierzchni. Rozpoznawany zbiór to wszystko, co obsługuje dostarczony plugin; identyfikator reguły, którego plugin nie rozpoznaje, daje zgłoszenie ‘unknown_rule’ zamiast cichego przejścia. |
entity_kind | string (enum) | tak | Rodzaj encji, który kodują wartości proposed/previous. Klasyfikacja reguły schema-evolution zależy od rodzaju; reguły strukturalne dotyczą określonych rodzajów. Dozwolone wartości: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate" |
proposed | object | tak | Sparsowana struktura klasyfikowanej encji. Host konwertuje YAML do JSON przed wysłaniem, więc plugin otrzymuje już ustrukturyzowaną wartość i nigdy nie widzi surowych bajtów. W wejściu reguły, która odczytuje całą encję Release, jest to encja Aggregate wdrażana przez tę encję Release. W każdym wejściu każda wartość parametru jest usuwana przed przekazaniem encji, ponieważ wartością parametru może być samo poświadczenie, więc żadna wartość parametru nie trafia do pluginu lintera przez to pole. Encja Aggregate zachowuje swoje deklaracje spec.parameters, z których każda zawiera tylko klucze dopuszczane przez schemat Aggregate w deklaracji parametru, z wyjątkiem default, i to samo dotyczy każdej deklaracji zagnieżdżonej pod properties, items i valuesType: default jest usuwany, a nie zastępowany, więc plugin nie może stwierdzić, czy deklaracja go podaje, a klucz, którego schemat w tym miejscu nie dopuszcza, jest usuwany wraz z całą zawartością. Blok parameters każdego modułu pod spec.aggregates, który przenosi wartości przekazywane do tego modułu, jest usuwany w całości, podobnie jak spec.parameters w encji każdego innego rodzaju. Tekst szablonu odczytujący parametr jest zachowywany w oryginalnej postaci. |
previous | object | nie | Sparsowana struktura encji w poprzedniej wersji, dla reguł wykonujących porównanie parami (schema-evolution), z wartościami parametrów usuniętymi dokładnie tak, jak z proposed. Pomijane, gdy reguła nie potrzebuje odniesienia do poprzedniej wersji (np. przy pierwszej publikacji lub w regułach wyłącznie strukturalnych). |
implemented_component | object | nie | Sparsowana struktura encji Component, którą sprawdzana encja Recipe wskazuje w spec.implements, rozwiązana przez hosta. Jest to powiązana encja INNEGO rodzaju niż sprawdzana, co odróżnia ją od previous: previous przenosi inną wersję tej samej encji, a to pole przenosi encję Component, której zadeklarowany kontrakt wyjściowy realizuje encja Recipe. Host rozwiązuje ją przez to samo wyszukiwanie w katalogu, którego używa kompilacja, według nazwy encji Component, więc wszystkie trzy formy przypięcia akceptowane przez spec.implements (bez wersji, dokładna, zakres zgodny co do wersji głównej) prowadzą do tego samego wpisu. Pomijane, gdy sprawdzana encja nie jest encją Recipe, gdy nie wskazuje żadnej encji Component lub gdy żadna encja Component o tej nazwie nie jest osiągalna w katalogach obszaru roboczego. Brak wartości oznacza, że porównanie jest niedostępne, a nie że kontrakt jest pusty: reguła odczytująca to pole nie generuje zgłoszenia, gdy go brak. |
release | object | nie | Sparsowana struktura encji Release wskazanej przez lint o zakresie wydania, z dołączonym łańcuchem extends, dzięki czemu potomna encja Release zawiera to, co dziedziczy po bazowej. Host konwertuje ją z YAML do JSON tak samo jak proposed. Jej blok spec.parameters zawiera wartości realizujące parametry encji Aggregate, dlatego jest usuwany w całości przed przekazaniem encji Release: wartością parametru może być samo poświadczenie, żadna reguła nie odczytuje tego bloku, więc żadna wartość parametru nie trafia do pluginu lintera przez to pole. Obecne tylko w wejściu reguły, która odczytuje całą encję Release, gdzie proposed jest encją Aggregate wdrażaną przez tę encję Release, z wartościami parametrów usuniętymi tak, jak opisuje proposed; pomijane w każdym innym wejściu. |
components | mapa object | nie | Encja Component, której instancją jest każda instancja komponentu w encji Aggregate, kluczowana nazwą instancji nadaną przez encję Aggregate, czyli tym samym kluczem, którego używają własne mapy components encji Aggregate i encji Release. Każda wartość to encja Component, do której rozwiązuje się typ instancji, z dołączonym ewentualnym łańcuchem extends, skonwertowana do JSON tak jak implemented_component. Instancja, której encja Component nie jest osiągalna w katalogach obszaru roboczego, jest nieobecna, a reguła traktuje ten brak jako niedostępność, a nie jako encję Component, która niczego nie deklaruje. Obecne tylko obok release, w wejściu reguły, która odczytuje całą encję Release; pomijane w każdym innym wejściu. |
source_path | string | nie | Ścieżka w systemie plików, z której wczytano encję. Wypełniana przez wywołujących po stronie hosta, którzy przechodzą system plików katalogu; używana przez reguły uwzględniające ścieżkę (np. category-matches-directory). Pomijana, gdy wywołujący nie ma kontekstu ścieżki. |
policies | Policies | nie | Konfiguracja dyscypliny publikowania dla danego obszaru roboczego, z której korzysta reguła, przenoszona jako obiekt Policies składany przez hosta z konfiguracji obszaru roboczego i ewentualnych nadpisań z wiersza poleceń. |
Dodatkowe właściwości są niedozwolone.
LinterOutput
Kształt odpowiedzi generowanej przez plugin publishing-linter. findings przenosi jeden wpis na każde wywołanie reguły, które dało wynik. Reguła schema-evolution generuje dokładnie jedno zgłoszenie (werdykt klasyfikacji); reguły strukturalne mogą wygenerować zero zgłoszeń (brak naruszeń) lub wiele (po jednym na naruszenie).
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
findings | Diagnostic[] | tak | Zgłoszenia poszczególnych reguł wygenerowane przez wywołanie pluginu, w kolejności ich emisji przez plugin. |
error | string | nie | Komunikat o niepowodzeniu ustawiany, gdy gość został uruchomiony, ale nie mógł ukończyć operacji; nieobecny w razie powodzenia. Różni się od diagnostyki przenoszonej przez wynik: diagnostyka zgłasza problemy wykryte podczas przebiegu, który mimo to dał wynik, natomiast błąd zgłasza, że sama operacja nie została ukończona. Host traktuje obecny błąd jako nieudane wywołanie pluginu. |
Dodatkowe właściwości są niedozwolone.
Policies
Konfiguracja dyscypliny publikowania dla danego obszaru roboczego, z której korzysta zestaw reguł, składana przez hosta z ustawień dyscypliny publikowania w konfiguracji obszaru roboczego oraz z ewentualnych nadpisań z wiersza poleceń. Ten schemat stanowi kontrakt dla tego kształtu. Pominięcie pola oznacza dla każdej flagi wartość domyślną false, a host zapisuje tylko pola, których wartość nie jest domyślna.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
allow_dynamic_refs | logiczna | nie | Gdy true, użycie $dynamicAnchor / $dynamicRef we wpisach SchemaLibrary jest dozwolone (wyłącza regułę dynamic-refs). Domyślnie false. |
allow_id_overrides | logiczna | nie | Gdy true, nadpisania $id we wpisach SchemaLibrary są dozwolone (wyłącza regułę id-overrides). Domyślnie false. |
allow_direct_x_aggrega_extensions | logiczna | nie | Gdy true, bezpośrednie tworzenie x-aggrega-selector / x-aggrega-inject jest dozwolone (wyłącza regułę x-aggrega-discouragement). Domyślnie false. |
allow_aggrega_ai_prefix | logiczna | nie | Gdy true, reguła annotation-prefix jest całkowicie wyłączona (zarówno sprawdzenie samego aggrega.ai/, jak i zależne od rodzaju sprawdzenie feature.aggrega.ai/). Domyślnie false. |
allow_nonstandard_names | logiczna | nie | Gdy true, naruszenia kształtu nazwy są dozwolone (wyłącza regułę name-shape). Domyślnie false. |
allow_category_mismatches | logiczna | nie | Gdy true, wyłącza ustalenia reguły category-matches-directory. Konwencja standardowego katalogu wymaga, aby encje Components w core/ |
allow_undeclared_recipe_provides | logiczna | nie | Gdy true, wyłącza ustalenia reguły provides-declared-by-component. Ta reguła zgłasza każdy klucz, który encja Recipe publikuje w spec.provides, a którego encja Component wskazana w jej spec.implements nie deklaruje w filarze provides swojego spec.schema. Publikowanie poza zadeklarowanym kontraktem jest akceptowane w czasie budowania, więc ustalenie ma charakter doradczy; obszar roboczy, którego encje Recipes celowo publikują klucze niezadeklarowane przez ich encję Component, może tu z niej zrezygnować. Domyślnie false. |
allow_connection_credential_mismatches | logiczna | nie | Gdy true, wyłącza ustalenia reguły connection-credential-matches-target-key. Ta reguła odczytuje całą encję Release i dla każdego połączenia, którego cel deklaruje klucz wymagany od wywołujących, porównuje poświadczenie przedstawiane przez połączenie z kluczem przechowywanym przez cel: zgłasza dwa końce wskazujące różne sekrety oraz klucz zadeklarowany tylko na jednym końcu. Zgodność obu końców jest konwencją katalogu, a nie czymś, co sprawdza budowanie, więc ustalenie ma charakter doradczy; obszar roboczy, którego oba końce celowo się różnią, może tu z niej zrezygnować. Domyślnie false. |
Dodatkowe właściwości są niedozwolone.