Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Schemat Aggrega Wasm Describe Socket

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-describe-v1beta1.schema.json

Kształt danych przesyłanych, który każdy plugin Wasm zwraca ze swojego eksportu describe() (PluginDescriptor). describe() to samodeklaracja pluginu, odczytywana jednorazowo przez hosta podczas ładowania pluginu: wersja ABI, względem której wiąże się gość, typ pluginu, oferowane eksporty wraz z deklaracją możliwości każdego z nich, samoopis możliwości na poziomie pluginu, opcjonalny kontrakt zachowania renderowania providera, opcjonalny kontrakt rozpoznawania importera, opcjonalne polecenia CLI, opcjonalny schemat ustawień oraz opcjonalne metadane autorstwa. Jeden kształt obejmuje każdy typ pluginu — provider, linter, krok potoku feature-recipe, governance, CLI, parser i importer. Host odczytuje describe() przed wywołaniem jakiegokolwiek innego eksportu i odrzuca deskryptor, którego nie może przyjąć, zamiast błędnie wywołać plugin podczas dyspozycji.

Jeden z następujących kształtów

  • PluginDescriptor

Definicje

PluginDescriptor

Pełna autodeklaracja pluginu, zwracana z describe() i odczytywana jednorazowo przy ładowaniu. Zawiera uzgadnianie zgodności ABI, typ pluginu, oferowane eksporty oraz opcjonalne powierzchnie właściwe dla danego typu (kontrakt zachowania renderowania providera, kontrakt rozpoznawania importera, polecenia pluginu CLI, schemat ustawień, metadane autorstwa).

WłaściwośćTypWymaganaOpis
abi_versionconst “v1beta1”takABI pluginu, względem którego wiąże się gość. Host akceptuje dokładnie tę wersję; gość zbudowany względem innego ABI zostaje odrzucony przy ładowaniu, zamiast zostać błędnie wywołany przy dyspozycji. Stała: "v1beta1"
plugin_typestring (enum)takRodzaj pluginu. Wybiera regułę minimalnego eksportu, którą sprawdza host, oraz, wraz z nazwą eksportu, domyślny wzorzec dostarczania danych wejściowych. Plugin typu governance pełni role transformacji i werdyktu w potoku budowania; to rola, w której jest dołączony — a nie jego rodzaj — określa, co może emitować. Dozwolone wartości: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer"
capabilitiesstring[]nieCo obsługuje plugin. Lista w formacie przesyłanym jest płaska, a sąsiednie wymagane pole plugin_type określa, które z czterech znaczeń ma każdy wpis: dla providera są to nazwy możliwości (takie jak helm lub compose), których kształt wyjścia renderuje; dla kroku potoku feature-recipe — możliwości providerów, z którymi jego krok jest zgodny; dla parsera — formaty źródłowe, które przekształca w kanoniczne drzewo strukturalne, każdy zapisany jako parse:; dla importera — obce formaty źródłowe, które przekształca w robocze pliki autorskie, każdy zapisany jako import:. Plugin typu linter, governance lub CLI nie jest rozwiązywany według możliwości i pozostawia tę listę pustą. Wpisy występują w zadeklarowanej kolejności i stanowią jawne deklaracje przetestowanej zgodności. Brak listy lub pusta lista nie deklaruje żadnej możliwości. Opublikowana encja katalogu zawiera te same wartości w bloku właściwym dla typu, któremu jej typ pluginu nadaje znaczenie, dzięki czemu czytający encję nigdy nie musi rozstrzygać, które znaczenie obowiązuje.
exportsPluginExport[]takEksporty oferowane przez plugin, w zadeklarowanej kolejności. Host sprawdza, czy obecny jest minimalny eksport właściwy dla typu, i wiąże powierzchnię hosta właściwą dla eksportu przed wywołaniem każdego eksportu.
contractProviderContractnieSamoopis zachowania renderowania providera — rodzaje danych wejściowych, które renderuje, sposób składania wyniku poszczególnych węzłów grupy dyspozycji oraz stosowana para ograniczników szablonów artefaktów. Opisuje providera jako całość, a nie pojedynczy eksport. Nieobecny w przypadku pluginu, który nie deklaruje kontraktu zachowania renderowania.
importerImporterContractnieSamoopis importera określający, jak rozpoznawane jest źródło w ogłaszanych przez niego formatach, gdy import nie wskazuje formatu. Może go zadeklarować tylko plugin, którego plugin_type to importer; każdy inny plugin, który go deklaruje, zostaje odrzucony przy ładowaniu. Nieobecny w przypadku importera, który nie deklaruje sposobu rozpoznawania swoich formatów; do jego formatów można wówczas dotrzeć tylko przez ich wskazanie.
descriptionstringnieWłasny, jednowierszowy, czytelny dla człowieka opis działania pluginu, odrębny od opisu poszczególnych eksportów i od opisu w metadanych encji. Ma charakter informacyjny; host ani go nie sprawdza, ani nie podejmuje na jego podstawie działań.
commandsPluginCLICommand[]nieCzasowniki poleceń najwyższego poziomu aggrega dodawane przez plugin CLI, każdy z własnym wierszem krótkiej pomocy. Jeden plugin CLI może dodać kilka poleceń; host rejestruje jedno polecenie na wpis i przy wywołaniu przekazuje gościowi rozwiązaną nazwę polecenia. Plugin inny niż CLI pozostawia to pole puste.
settings_schemaobjectnieOpcjonalny dokument JSON Schema, który plugin deklaruje, aby określić typ ustawień dostarczanych przez operatora w jego dołączeniu. Jeśli jest obecny, host kompiluje go przy ładowaniu i przy dyspozycji, przed wywołaniem pluginu, sprawdza względem niego ustawienia dołączenia; niezgodne ustawienia zatrzymują budowanie. Jeśli jest nieobecny, plugin nie deklaruje kształtu, a ustawienia są przekazywane dosłownie. Schemat jest własną, swobodną deklaracją pluginu; host wykonuje względem niego ogólną walidację JSON Schema i nie interpretuje znaczenia ustawień.
metadataPluginDescriptorMetanieOpcjonalne informacje o autorstwie i pochodzeniu kompilacji. Nie niosą żadnego kontraktu zachowania — host ani ich nie sprawdza, ani nie podejmuje na ich podstawie działań.

Dodatkowe właściwości są niedozwolone.

PluginExport

Jeden eksport oferowany przez plugin, zadeklarowany w describe(). Host kieruje wywołania do eksportu według jego nazwy i wiąże powierzchnię hosta o najmniejszych uprawnieniach, jakiej wymagają zadeklarowane przez eksport funkcje hosta.

WłaściwośćTypWymaganaOpis
namestringtakNazwa ABI eksportu — na przykład render_node, assemble_boundary, lint_rules lub step. Host kieruje wywołania do eksportu według tej nazwy.
input_patternstring (enum)nieSposób, w jaki host dostarcza dane wejściowe eksportu: b dostarcza pełny ładunek bezpośrednio, więc gość renderuje wyłącznie na jego podstawie; a dostarcza niewielki ładunek, który gość uzupełnia za pomocą funkcji hosta. Eksport, który pomija to pole, przyjmuje wartość domyślną wynikającą z typu pluginu i nazwy. Dozwolone wartości: "a", "b"
host_functionsstring[]nieNazwy funkcji hosta importowanych przez ten eksport. Każda nazwa musi znajdować się na liście dozwolonych funkcji hosta. Deklaracja jest wiążąca i przy ładowaniu jest porównywana z funkcjami, które gość faktycznie importuje ze swojego modułu, więc nie może rozejść się z funkcjami, które gość rzeczywiście wywołuje.
descriptionstringnieOpcjonalny, czytelny dla człowieka tekst opisujący eksport. Stanowi dokumentację dla czytelników katalogu; host ani go nie sprawdza, ani nie podejmuje na jego podstawie działań.
stabilitystring (enum)niePoziom stabilności eksportu. Pominięta wartość nie niesie żadnego twierdzenia o stabilności. Dozwolone wartości: "stable", "experimental", "deprecated"
operatesstring (enum)nieOperacja potoku wykonywana przez ten eksport: patch modyfikuje istniejący wyrenderowany dokument, emit dodaje nowy dokument. Kształt wartości jest sprawdzany przy ładowaniu; środowisko uruchomieniowe odczytuje ją podczas dyspozycji kroku. Dozwolone wartości: "patch", "emit"
scopestring (enum)nieKorzeń dokumentów, na którym działa ten eksport: own to własne wyrenderowane dokumenty węzła, host to dokumenty komponentu, do którego dołączona jest feature recipe o zakresie komponentu. Kształt wartości jest sprawdzany przy ładowaniu; środowisko uruchomieniowe rozwiązuje dokumenty zakresu podczas dyspozycji. Dozwolone wartości: "own", "host"
selectorstringnieSwobodny, czytelny dla człowieka opis tego, na czym działa eksport. Stanowi dokumentację dla czytelników katalogu; host ani nie sprawdza jego treści, ani nie podejmuje na jego podstawie działań.
inputobjectnieOpcjonalny dokument JSON Schema, który eksport kroku deklaruje, aby określić typ lokalnych danych wejściowych kroku dostarczanych przez wpis potoku w bloku with. Jeśli jest obecny, opisuje kształt, który spełniają dane wejściowe with kroku; jeśli jest nieobecny, eksport nie deklaruje kontraktu wejścia. Schemat jest własną, swobodną deklaracją eksportu opisującą powierzchnię wejścia, do której autor potoku kieruje dane dla tego eksportu.
outputobjectnieOpcjonalny dokument JSON Schema, który eksport kroku deklaruje, aby określić typ wyników zwracanych dla jednego kroku — kształt adresowalnych wyników, które krok udostępnia do odczytu późniejszemu krokowi lub szablonowi. Jeśli jest obecny, opisuje kształt tych zwracanych wyników; jeśli jest nieobecny, eksport nie deklaruje kontraktu wyjścia. Schemat jest własną, swobodną deklaracją eksportu opisującą powierzchnię wyjścia, którą ten eksport wytwarza.

Dodatkowe właściwości są niedozwolone.

PluginCLICommand

Jeden czasownik polecenia najwyższego poziomu aggrega dodawany przez plugin CLI, zadeklarowany w describe(). Host rejestruje jedno polecenie na wpis i przy wywołaniu przekazuje gościowi z powrotem rozwiązaną nazwę polecenia, więc jeden gość może obsługiwać kilka poleceń i wybierać zachowanie na podstawie nazwy.

WłaściwośćTypWymaganaOpis
namestringtakCzasownik polecenia rejestrowany przez hosta — token aggrega wywoływany przez operatora i wyróżnik, który host przekazuje gościowi, aby ten mógł rozpoznać, które polecenie zostało wywołane. Każde zadeklarowane polecenie musi go podawać.
descriptionstringnieJednowierszowy tekst krótkiej pomocy polecenia, wyświetlany na liście poleceń i w wyniku pomocy. Jest to opcjonalna dokumentacja; host ani jej nie sprawdza, ani nie podejmuje na jej podstawie działań.
flagsPluginCommandFlag[]nieFlagi polecenia w zadeklarowanej kolejności. Każdy wpis wnosi jedną flagę, którą host rejestruje w poleceniu, aby aggrega help wyświetlało ją tak jak flagę polecenia podstawowego. Polecenie bez flag pozostawia tę listę pustą.

Dodatkowe właściwości są niedozwolone.

PluginCommandFlag

Jedna flaga, którą plugin CLI deklaruje dla polecenia, zgłaszana w describe(). Host rejestruje ją w poleceniu, tak aby aggrega help wyświetlało ją obok flag polecenia podstawowego.

WłaściwośćTypWymaganaOpis
namestringtakDługa nazwa flagi — token —name, który operator przekazuje w wierszu poleceń. Każda zadeklarowana flaga musi ją podawać. Co najmniej 1 znak.
shorthandstringnieOpcjonalny jednoznakowy krótki alias flagi — forma -x, którą operator może przekazać zamiast długiej nazwy. Brak oznacza, że flaga nie ma krótkiego aliasu.
descriptionstringnieJednowierszowy tekst pomocy flagi, wyświetlany w wyniku pomocy polecenia. Jest to opcjonalna dokumentacja; host ani jej nie sprawdza, ani nie podejmuje na jej podstawie działań.
typestringnieTyp wartości flagi — na przykład string, bool lub int. Brak nie deklaruje żadnego typu.
defaultstringnieDomyślna wartość flagi, gdy operator jej nie przekaże, wyrażona jako ciąg znaków. Brak oznacza, że flaga nie deklaruje wartości domyślnej.

Dodatkowe właściwości są niedozwolone.

PluginDescriptorMeta

Opcjonalne metadane o autorstwie i pochodzeniu kompilacji, które plugin deklaruje w describe(). Mają charakter informacyjny; host ich nie sprawdza ani nie podejmuje na ich podstawie działań. Pola version i commit to dane o pochodzeniu kompilacji wpisywane do gościa w czasie kompilacji; kompilacja bez tych danych je pomija.

WłaściwośćTypWymaganaOpis
authorstringnieAutor pluginu.
repositorystringnieRepozytorium źródłowe pluginu.
licensestringnieIdentyfikator licencji pluginu.
versionstringnieWersja pochodzenia kompilacji wpisana do gościa w czasie kompilacji. Pomijana przez kompilację bez tych danych.
commitstringnieSkrócony identyfikator commitu, z którego zbudowano gościa. Pomijany przez kompilację bez tych danych.

Dodatkowe właściwości są niedozwolone.

ProviderContract

Samodeklaracja providera dotycząca zachowań renderowania w czasie kompilacji, które wykonuje dla renderowanych węzłów — akceptowanych rodzajów wejścia, tego, czy i jak składa wynik poszczególnych węzłów grupy dyspozycji w jeden artefakt, pary ograniczników szablonów Go stosowanej do importowanych plików artefaktów, tego, czy akceptuje pliki, które Recipe dodaje do wspólnego wyniku swojej granicy, oraz plików, których jego ekosystem nigdy nie dostarcza obok źródła. Opisuje providera jako całość, a nie pojedynczy eksport. Bramka ładowania porównuje ją z deklaracją zapisaną w encji.

WłaściwośćTypWymaganaOpis
input_kindsInputKindstakKtóre z trzech rodzajów wejścia encji Recipe plugin renderuje: zestaw plików ze źródła, syntetyzowane obciążenie oraz samodzielny węzeł zawierający wyłącznie artefakty.
boundary_assemblystring (enum)takSposób, w jaki plugin łączy wynik renderowania poszczególnych węzłów grupy dyspozycji: none zapisuje wynik każdego węzła bezpośrednio w ścieżce dyspozycji, merge scala fragmenty poszczególnych węzłów w jeden dokument, a nest umieszcza wynik każdego węzła na jego własnej pozycji w strukturze nadrzędnej. Pusta wartość nie deklaruje sposobu składania. Dozwolone wartości: "none", "merge", "nest", ""
artifact_delimitersArtifactDelimitersniePara ograniczników szablonów Go, którą plugin stosuje do importowanych plików artefaktów. Brak oznacza domyślną parę otwierającą/zamykającą; plugin, którego składnia docelowa koliduje z tą parą, podaje tu parę alternatywną.
assembly_name_annotationAssemblyNameAnnotationnieAdnotacja granicy, której rozwiązana wartość nadaje nazwę artefaktowi składanemu przez plugin z grupy dyspozycji. Brak oznacza, że plugin nadaje nazwę złożeniu wyłącznie na podstawie ścieżki dyspozycji.
reusable_instancelogicznanieCzy jedna załadowana instancja pluginu może obsługiwać każde przejście renderowania, składania i walidacji w kompilacji, zamiast nowej instancji dla każdego przejścia. Plugin deklaruje true tylko wtedy, gdy nie przechowuje stanu między przejściami. Brak (false) to bezpieczna wartość domyślna: host ładuje nową instancję dla każdego przejścia.
cross_boundary_linkinglogicznanieCzy plugin łączy krawędzie uses przekraczające granice — krawędzie, których końce konsumujący i konsumowany są składane w różnych grupach dyspozycji — tworząc natywne dla providera powiązania odwołań krzyżowych za pomocą eksportów link_publish i link_resolve. Plugin deklaruje true tylko wtedy, gdy eksportuje oba. Brak (false) to bezpieczna wartość domyślna: plugin nie łączy krawędzi przekraczających granice.
omitslogicznanieCzy plugin respektuje wpisy omit zawarte w wejściu render_node: pomija każdą renderowaną jednostkę dopasowaną przez wpis we wszystkim, co zwraca, i podaje w polu omitted wyniku jedną liczbę dla każdego przekazanego mu wpisu. Plugin deklaruje true tylko wtedy, gdy robi jedno i drugie. Brak (false) to bezpieczna wartość domyślna: plugin nie deklaruje, że cokolwiek pomija.
boundary_artifactslogicznanieCzy cel pluginu akceptuje pliki, które Recipe dodaje do wspólnego wyniku granicy, w której jest renderowana. Host przetwarza te pliki i zapisuje każdy z nich raz, w katalogu zawierającym złożony wynik grupy dyspozycji, obok tego, co zapisuje złożenie pluginu; plugin nie otrzymuje żadnego z nich i żadnego nie odczytuje, więc deklaracja stwierdza, że jego cel traktuje umieszczony tam plik jako część wyniku granicy. Brak (false) to bezpieczna wartość domyślna: Recipe deklarująca takie pliki dla tego pluginu jest odrzucana, zanim cokolwiek zostanie wyrenderowane.
nest_segmentstringnieKatalog, w którym cel pluginu umieszcza własny podkatalog każdego współtwórcy, w przypadku pluginu zagnieżdżającego wynik poszczególnych węzłów grupy dyspozycji. Host łączy ten segment, nazwę współtwórcy na poziomie tworzenia oraz własną ścieżkę każdego pliku. Odczytywane tylko wtedy, gdy boundary_assembly ma wartość nest. W razie braku host umieszcza podkatalog każdego współtwórcy bezpośrednio w pozycji dyspozycji, bez katalogu nadrzędnego. Wartość wskazuje jeden katalog, nigdy ścieżkę: wartość zawierająca separator ścieżki albo wskazująca katalog bieżący lub nadrzędny jest odrzucana, ponieważ host wstawia do niej nazwę współtwórcy, a fragment ścieżki umieściłby pliki współtwórcy gdzie indziej niż pod pozycją dyspozycji.
source_ignoreSourceIgnoreniePliki, których ekosystem tego pluginu nigdy nie dostarcza obok renderowanego źródła, zadeklarowane jako reguły ignorowania. Host odczytuje tę deklarację, gdy autor przypina Recipe lub FeatureRecipe, której możliwość obsługuje dla niego ten plugin: łączy te reguły z własnym plikiem ignorowania autora, zapisuje połączone reguły w blokadzie encji obok encji i od tej pory każda publikacja encji, każde porównanie jej lokalnego źródła i każde jej renderowanie stosuje zapisane reguły, zamiast ponownie pytać plugin. Zatem Recipe opublikowana dla danej możliwości zawiera pliki zachowane przez reguły jej wydawcy, a plugin ją renderuje, gdy posługuje się tą samą wersją ABI, jego kontrakt jest zgodny z deklaracją encji i nie potrzebuje żadnego pliku spoza tego zestawu. Plugin, który potrzebuje pliku pominiętego w zestawie, musi głośno przerwać kompilację i wskazać ten plik; rolą hosta jest odmowa spakowania lub odczytu pliku, którego zestaw nie zawiera, ze wskazaniem go. Brak nie deklaruje żadnych reguł ignorowania, a renderowane przez plugin źródło zachowuje wtedy każdy plik zachowany przez własne reguły autora.

Dodatkowe właściwości są niedozwolone.

SourceIgnore

Reguły ignorowania, które ekosystem pluginu stosuje do katalogu źródłowego, w składni gitignore: wzorzec bez ukośnika lub tylko z ukośnikiem końcowym dopasowuje nazwę na dowolnej głębokości, wzorzec z ukośnikiem w innym miejscu jest odczytywany od korzenia katalogu, którego dotyczy, ukośnik końcowy dopasowuje tylko katalog, a początkowy ! przywraca to, co wykluczyła wcześniejsza reguła. Reguły są stosowane po kolei, a późniejsze dopasowanie zastępuje wcześniejsze. Do katalogu wykluczonego przez regułę nie wchodzi się, więc nic pod nim nie zostaje przywrócone, chyba że najpierw zostanie przywrócony sam katalog.

WłaściwośćTypWymaganaOpis
patternsstring[]nieWłasne wzorce ignorowania ekosystemu, każdy odnoszący się do korzenia przeglądanego lokalnego katalogu źródłowego, w kolejności stosowania. Brak lub pusta lista nie deklaruje żadnych.
filesstring[]nieNazwy plików ignorowania, które ekosystem respektuje wewnątrz źródła — na przykład .helmignore dla chartu. Wszędzie tam, gdzie podczas przeglądania źródła zostanie znaleziony plik o jednej z tych nazw, jego wiersze są odczytywane jako kolejne wzorce w tej samej składni, każdy odnoszący się do katalogu zawierającego plik, i są stosowane po powyższych wzorcach; puste wiersze i wiersze zaczynające się od # są pomijane. Plik o takiej nazwie sam jest dołączany, chyba że wyklucza go reguła. Brak lub pusta lista nie wskazuje żadnych.

Dodatkowe właściwości są niedozwolone.

InputKinds

Rodzaje danych wejściowych encji Recipe, które plugin renderuje. Każde pole jest niezależną deklaracją; plugin może zgłosić dowolną kombinację.

WłaściwośćTypWymaganaOpis
sourcedlogicznatakCzy plugin renderuje pozyskany zestaw plików (chart, moduł, plik compose).
synthesizedlogicznatakCzy plugin renderuje syntetyzowane obciążenie.
artifacts_standalonelogicznatakCzy plugin renderuje samodzielny węzeł zawierający wyłącznie artefakty — taki, który niesie zaimportowane dokumenty artefaktów, a nie ma źródła ani obciążenia.

Dodatkowe właściwości są niedozwolone.

ArtifactDelimiters

Para ograniczników szablonów Go, którą plugin stosuje do zaimportowanych plików artefaktów, zgłaszana, gdy różni się od pary domyślnej.

WłaściwośćTypWymaganaOpis
leftstringtakOgranicznik otwierający.
rightstringtakOgranicznik zamykający.

Dodatkowe właściwości są niedozwolone.

AssemblyNameAnnotation

Adnotacja granicy, której rozwiązana wartość nazywa artefakt złożony przez plugin, zgłaszana, gdy plugin łączy granice współtworzące grupę dyspozycji w jeden nazwany zestaw.

WłaściwośćTypWymaganaOpis
annotationstringtakKlucz adnotacji granicy, z którego plugin odczytuje nazwę złożonego artefaktu.
require_uniquelogicznanieCzy wszystkie granice współtworzące jedną grupę dyspozycji muszą być zgodne co do rozwiązanej wartości adnotacji. Gdy true, grupa, której granice rozwiązują adnotację do różnych wartości, zatrzymuje kompilację; gdy false, plugin przyjmuje pierwszą rozwiązaną wartość.

Dodatkowe właściwości są niedozwolone.

ImporterContract

Co importer deklaruje o swoich formatach poza ich ogłaszaniem: sygnatury, po których rozpoznaje się źródło w tych formatach. Gdy import nie wskazuje formatu, host odczytuje sygnatury zapisane przez każdy importer, spośród których import wybiera — importery z katalogu obszaru roboczego oraz importery rdzenia kompilatora, których encje Plugin zawiera plik binarny — dopasowuje każdą do źródła, nie wiedząc, czym jest którykolwiek format, i odczytuje źródło jako format tego jednego importera, którego sygnatura pasuje. Źródło, do którego nie pasuje żadna sygnatura, jest odrzucane z prośbą o podanie formatu, a źródło, do którego pasują sygnatury więcej niż jednego formatu, jest odrzucane z ich wymienieniem. Encja Plugin zapisuje tę samą listę, a host odrzuca importer, którego raport describe() różni się od zapisu.

WłaściwośćTypWymaganaOpis
detectDetectSignature[]nieSygnatury rozpoznające źródło w formatach tego importera, w zadeklarowanej kolejności; źródło zostaje rozpoznane, gdy pasuje do niego którakolwiek z nich. Źródło rozpoznane przez importer jest rozpoznawane jako każdy format, który importer ogłasza, więc importer ogłaszający więcej niż jeden format ma każde dopasowanie odrzucane jako niejednoznaczne, a importer, którego źródła muszą być rozpoznawane, ogłasza jeden format. Brak lub pusta lista nie deklaruje żadnej sygnatury, a do formatów importera można dotrzeć tylko przez ich wskazanie.

Dodatkowe właściwości są niedozwolone.

DetectSignature

Jeden sposób rozpoznania źródła: składnia, w której źródło jest odczytywane, nazwy plików, do których stosuje się sygnatura, oraz predykaty, które musi spełniać sparsowane drzewo. Pasuje do pliku, którego nazwa pasuje do jednego z jej wzorców plików — albo, jeśli nie deklaruje żadnego, do źródła będącego jednym plikiem, niezależnie od jego nazwy — którego bajty dają się sparsować w jej składni i którego sparsowane drzewo spełnia każdy z jej predykatów. Pasuje do katalogu, gdy pasuje do jednego z plików katalogu wybranych przez jej wzorce, więc sygnatura niedeklarująca żadnego wzorca nie pasuje do żadnego katalogu.

WłaściwośćTypWymaganaOpis
syntaxstringtakFormat składniowy, w jakim parsowane jest źródło — na przykład json lub yaml — czyli format, który plugin parsera ogłasza jako parse:. Host parsuje źródło za pomocą parsera, który katalog obszaru roboczego udostępnia dla tej składni, a w przypadku składni, dla której katalog nie udostępnia żadnego, za pomocą parsera wbudowanego w kompilator, co najwyżej raz niezależnie od liczby sygnatur wskazujących tę składnię; źródło, które nie daje się w niej sparsować, nie pasuje do żadnej sygnatury ją wskazującej. Składnia, dla której żaden z nich nie udostępnia parsera, zatrzymuje rozpoznawanie ze wskazaniem braku tego parsera, zamiast zostać pominięta. Co najmniej 1 znak długości.
filesstring[]nieWzorce nazw plików, do których stosuje się sygnatura, dopasowywane do końca nazwy źródła z separatorami odczytywanymi jako ukośniki: wzorzec złożony z jednego segmentu jest dopasowywany do własnej nazwy pliku, a wzorzec złożony z kilku segmentów rozdzielonych ukośnikami — do tylu końcowych segmentów jego ścieżki, więc .vscode/mcp.json pasuje do pliku o nazwie mcp.json w katalogu o nazwie .vscode. W obrębie segmentu * pasuje do dowolnego ciągu znaków, ? do jednego znaku, a […] do jednego znaku z klasy. Sygnatura ma zastosowanie, gdy pasuje którykolwiek wzorzec. Wzorzec o niepoprawnej postaci jest odrzucany przy ładowaniu. Brak lub pusta lista stosuje sygnaturę do źródła będącego jednym plikiem, niezależnie od jego nazwy, i do żadnego pliku katalogu. Wzorce sygnatur importera decydują też o tym, które pliki katalogu import mu przekazuje.
matchPathMatch[]niePredykaty, które musi spełniać sparsowane drzewo, wszystkie, w zadeklarowanej kolejności. Brak lub pusta lista nie wymaga od drzewa niczego poza sparsowaniem w danej składni.

Dodatkowe właściwości są niedozwolone.

PathMatch

Jeden predykat na sparsowanym drzewie: wartość, do której prowadzi ścieżka, rodzaj wartości, jakim ma być, oraz opcjonalnie ciąg, któremu ma być równa lub od którego ma się zaczynać.

WłaściwośćTypWymaganaOpis
pathstringtakMiejsce w drzewie, które sprawdza predykat, zapisane jako klucze połączone kropkami od wierzchołka drzewa: data.nodes wskazuje element nodes obiektu data najwyższego poziomu. Segment zapisany jako liczba całkowita, 0 lub większa, wybiera tę pozycję tablicy, licząc od zera, więc nodes.0.type wskazuje type pierwszego węzła; każdy inny segment wybiera element obiektu. Klucza, który sam zawiera kropkę, nie da się wskazać. Co najmniej 1 znak długości.
isstring (enum)takDo czego ścieżka musi prowadzić: present jest spełnione, gdy prowadzi do wartości dowolnego rodzaju, łącznie z null; absent jest spełnione, gdy nie prowadzi do niczego; object, array, string, number i boolean są spełnione, gdy prowadzi do wartości danego rodzaju. Dozwolone wartości: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstringnieCiąg, któremu wartość, do której prowadzi ścieżka, musi być dokładnie równa. Wartość niebędąca ciągiem nigdy nie jest mu równa. W jednym predykacie deklaruje się co najwyżej jedno z equals i prefix, a predykat deklarujący oba jest odrzucany przy ładowaniu. Co najmniej 1 znak długości.
prefixstringnieCiąg, od którego musi się zaczynać wartość, do której prowadzi ścieżka. Wartość niebędąca ciągiem nigdy się od niego nie zaczyna. W jednym predykacie deklaruje się co najwyżej jedno z equals i prefix, a predykat deklarujący oba jest odrzucany przy ładowaniu. Co najmniej 1 znak długości.

Dodatkowe właściwości są niedozwolone.