Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Skema Aggrega Wasm Describe Socket

Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.

ID skema: https://aggrega.ai/schemas/wasm-describe-v1beta1.schema.json

Bentuk wire yang dikembalikan setiap plugin Wasm dari ekspor describe()-nya (PluginDescriptor). describe() adalah deklarasi diri plugin, yang dibaca sekali oleh host saat memuat plugin: versi ABI yang menjadi acuan pengikatan guest, jenis plugin, ekspor yang ditawarkannya beserta deklarasi kapabilitas setiap ekspor, laporan mandiri kapabilitas di tingkat plugin, kontrak perilaku render provider yang opsional, kontrak pengenalan importer yang opsional, perintah CLI yang opsional, skema pengaturan yang opsional, dan metadata kepengarangan yang opsional. Satu bentuk mencakup setiap jenis plugin — provider, linter, langkah pipeline feature-recipe, tata kelola, CLI, parser, dan importer. Host membaca describe() sebelum men-dispatch ekspor lain mana pun dan menolak deskriptor yang tidak dapat diterimanya, alih-alih memanggil plugin secara keliru saat dispatch.

Salah satu dari bentuk berikut

  • PluginDescriptor

Definisi

PluginDescriptor

Deklarasi diri lengkap sebuah plugin, yang dikembalikan dari describe() dan dibaca sekali saat pemuatan. Deklarasi ini memuat jabat tangan kompatibilitas ABI, jenis plugin, ekspor yang ditawarkan, dan permukaan opsional per jenis (kontrak perilaku render sebuah provider, kontrak pengenalan sebuah importer, perintah sebuah plugin CLI, skema pengaturan, metadata kepengarangan).

PropertiJenisWajibDeskripsi
abi_versionconst “v1beta1”yaABI plugin yang diikat oleh guest. Host hanya menerima versi ini; guest yang dibangun terhadap ABI lain ditolak saat pemuatan alih-alih dipanggil secara keliru saat dispatch. Konstanta: "v1beta1"
plugin_typestring (enum)yaJenis plugin. Jenis ini memilih aturan ekspor minimum yang divalidasi host dan, bersama nama ekspor, pola pengiriman input bawaan. Plugin governance melayani peran transformasi dan putusan dalam pipeline build; peran tempat plugin dilampirkan — bukan jenisnya — yang menentukan apa yang boleh dikeluarkannya. Nilai yang diizinkan: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer"
capabilitiesstring[]tidakApa yang dilayani plugin. Daftar ini datar di wire, dan plugin_type wajib di sebelahnya menentukan mana dari empat makna yang dibawa setiap entri: untuk provider, nama kapabilitas (seperti helm atau compose) yang bentuk keluarannya dirender; untuk langkah feature-recipe-pipeline, kapabilitas provider yang kompatibel dengan langkahnya; untuk parser, format sumber yang diubahnya menjadi pohon terstruktur kanonis, masing-masing ditulis sebagai parse:; untuk importer, format sumber asing yang diubahnya menjadi berkas authoring draf, masing-masing ditulis sebagai import:. Plugin linter, governance, atau CLI tidak di-resolve berdasarkan kapabilitas dan membiarkannya kosong. Entri mengikuti urutan deklarasi dan merupakan klaim kompatibilitas yang eksplisit dan teruji. Daftar yang tidak ada atau kosong tidak mendeklarasikan klaim kapabilitas. Entitas katalog yang dipublikasikan membawa nilai yang sama di bawah blok per jenis yang diberi makna oleh jenis pluginnya, sehingga pembaca entitas tidak perlu memutuskan makna mana yang berlaku.
exportsPluginExport[]yaEkspor yang ditawarkan plugin, dalam urutan deklarasi. Host memvalidasi bahwa ekspor minimum per jenis ada dan mengikat permukaan host per ekspor sebelum memanggil setiap ekspor.
contractProviderContracttidakLaporan diri perilaku render provider — jenis input yang direndernya, cara ia merakit keluaran per node dari sebuah grup dispatch, dan pasangan pembatas templat artefak yang diterapkannya. Laporan ini menjelaskan provider secara keseluruhan, bukan satu ekspor tertentu. Tidak ada untuk plugin yang tidak mendeklarasikan kontrak perilaku render.
importerImporterContracttidakLaporan diri sebuah importer tentang cara sumber dari format yang diiklankannya dikenali ketika sebuah impor tidak menyebutkan format. Hanya plugin yang plugin_type-nya importer yang boleh mendeklarasikannya; plugin lain yang mendeklarasikannya ditolak saat pemuatan. Tidak ada untuk importer yang tidak mendeklarasikan cara mengenali formatnya, sehingga formatnya hanya dapat dicapai dengan menyebutkannya.
descriptionstringtidakDeskripsi satu baris yang dapat dibaca manusia dari plugin itu sendiri tentang apa yang dilakukannya, berbeda dari deskripsi per ekspor dan dari deskripsi metadata entitas. Deskripsi ini bersifat informatif; host tidak memvalidasi maupun bertindak berdasarkannya.
commandsPluginCLICommand[]tidakKata kerja perintah aggrega tingkat atas yang disumbangkan plugin CLI, masing-masing dengan baris bantuan singkatnya sendiri. Satu plugin CLI dapat menyumbangkan beberapa perintah; host mendaftarkan satu perintah per entri dan meneruskan nama perintah yang di-resolve ke guest saat pemanggilan. Plugin non-CLI membiarkannya kosong.
settings_schemaobjecttidakDokumen JSON Schema opsional yang dideklarasikan plugin untuk memberi tipe pada pengaturan yang disediakan operator dan dibawa oleh lampirannya. Jika ada, host mengompilasinya saat pemuatan dan memvalidasi pengaturan lampiran terhadapnya saat dispatch sebelum memanggil plugin; pengaturan yang tidak sesuai menghentikan build. Jika tidak ada, plugin tidak mendeklarasikan bentuk dan pengaturan diteruskan apa adanya. Skema ini adalah deklarasi bebas milik plugin itu sendiri; host menjalankan validasi JSON Schema generik terhadapnya dan tidak menafsirkan makna pengaturan.
metadataPluginDescriptorMetatidakInformasi opsional tentang kepengarangan dan asal-usul build. Informasi ini tidak membawa kontrak perilaku — host tidak memvalidasi maupun bertindak berdasarkannya.

Properti tambahan tidak diizinkan.

PluginExport

Satu ekspor yang ditawarkan plugin, sebagaimana dideklarasikan dalam describe(). Host melakukan dispatch ke ekspor berdasarkan namanya dan mengikat permukaan host dengan hak akses minimum yang diperlukan oleh fungsi host yang dideklarasikan ekspor.

PropertiJenisWajibDeskripsi
namestringyaNama ABI ekspor — misalnya render_node, assemble_boundary, lint_rules, atau step. Host melakukan dispatch ke ekspor berdasarkan nama ini.
input_patternstring (enum)tidakCara host mengirimkan input ekspor: b mengirimkan seluruh payload secara inline sehingga guest merender hanya dari payload; a mengirimkan payload kecil yang diperkaya guest melalui fungsi host. Ekspor yang menghilangkan field ini mengambil nilai bawaan berdasarkan jenis plugin dan namanya. Nilai yang diizinkan: "a", "b"
host_functionsstring[]tidakNama fungsi host yang diimpor oleh ekspor ini. Setiap nama harus ada dalam daftar izin fungsi host. Deklarasi ini otoritatif dan diperiksa silang saat pemuatan terhadap fungsi yang benar-benar diimpor guest dari modulnya, sehingga tidak dapat menyimpang dari fungsi yang benar-benar dipanggil guest.
descriptionstringtidakTeks opsional yang dapat dibaca manusia yang menjelaskan ekspor. Ini adalah dokumentasi untuk pembaca katalog; host tidak memvalidasi maupun bertindak berdasarkannya.
stabilitystring (enum)tidakTingkat stabilitas ekspor. Nilai yang dihilangkan tidak membawa klaim stabilitas. Nilai yang diizinkan: "stable", "experimental", "deprecated"
operatesstring (enum)tidakOperasi pipeline yang dilakukan ekspor ini: patch mengubah dokumen hasil render yang sudah ada, emit menambahkan dokumen baru. Bentuk nilai ini diperiksa saat pemuatan; runtime membacanya saat melakukan dispatch langkah. Nilai yang diizinkan: "patch", "emit"
scopestring (enum)tidakAkar dokumen tempat ekspor ini beroperasi: own adalah dokumen hasil render milik node itu sendiri, host adalah dokumen dari komponen tempat feature recipe bercakupan komponen dilampirkan. Bentuk nilai ini diperiksa saat pemuatan; runtime me-resolve dokumen cakupan tersebut saat melakukan dispatch. Nilai yang diizinkan: "own", "host"
selectorstringtidakDeskripsi bebas yang dapat dibaca manusia tentang apa yang ditangani ekspor. Ini adalah dokumentasi untuk pembaca katalog; host tidak memvalidasi isinya maupun bertindak berdasarkannya.
inputobjecttidakDokumen JSON Schema opsional yang dideklarasikan ekspor langkah untuk memberi tipe pada input lokal langkah yang disediakan entri pipeline melalui blok with-nya. Jika ada, dokumen ini menjelaskan bentuk yang dipenuhi input with sebuah langkah; jika tidak ada, ekspor tidak mendeklarasikan kontrak input. Skema ini adalah deklarasi bebas milik ekspor itu sendiri tentang permukaan input yang dituju penulis pipeline untuk ekspor ini.
outputobjecttidakDokumen JSON Schema opsional yang dideklarasikan ekspor langkah untuk memberi tipe pada keluaran yang dikembalikannya untuk satu langkah — bentuk keluaran beralamat yang disumbangkan sebuah langkah untuk dibaca langkah berikutnya atau templat. Jika ada, dokumen ini menjelaskan bentuk keluaran yang dikembalikan tersebut; jika tidak ada, ekspor tidak mendeklarasikan kontrak keluaran. Skema ini adalah deklarasi bebas milik ekspor itu sendiri tentang permukaan keluaran yang dihasilkan ekspor ini.

Properti tambahan tidak diizinkan.

PluginCLICommand

Satu kata kerja perintah aggrega tingkat atas yang disumbangkan plugin CLI, sebagaimana dideklarasikan dalam describe(). Host mendaftarkan satu perintah per entri dan meneruskan kembali nama perintah yang di-resolve ke guest saat pemanggilan, sehingga satu guest dapat mendukung beberapa perintah dan memilih perilakunya berdasarkan nama.

PropertiJenisWajibDeskripsi
namestringyaKata kerja perintah yang didaftarkan host — token aggrega yang dipanggil operator dan diskriminator yang diserahkan host kepada guest agar guest dapat merutekan berdasarkan perintah yang dipanggil. Setiap perintah yang dideklarasikan harus menyebutkannya.
descriptionstringtidakTeks bantuan singkat satu baris untuk perintah, yang ditampilkan dalam daftar perintah dan keluaran bantuan. Ini adalah dokumentasi opsional; host tidak memvalidasi maupun bertindak berdasarkannya.
flagsPluginCommandFlag[]tidakFlag perintah tersebut, dalam urutan yang dideklarasikan. Setiap entri menyumbangkan satu flag yang didaftarkan host pada perintah tersebut sehingga aggrega help menampilkannya seperti flag perintah inti. Perintah tanpa flag membiarkannya kosong.

Properti tambahan tidak diizinkan.

PluginCommandFlag

Satu flag yang dideklarasikan oleh plugin CLI pada sebuah perintah, sebagaimana dilaporkan dalam describe(). Host mendaftarkannya pada perintah tersebut sehingga aggrega help mencantumkannya bersama flag milik perintah inti.

PropertiJenisWajibDeskripsi
namestringyaNama panjang flag — token —name yang diberikan operator di baris perintah. Setiap flag yang dideklarasikan harus menyebutkannya. Panjang minimal 1 karakter.
shorthandstringtidakAlias pendek opsional satu karakter untuk flag — bentuk -x yang dapat diberikan operator sebagai pengganti nama panjang. Jika tidak ada, flag tidak memiliki alias pendek.
descriptionstringtidakTeks bantuan satu baris untuk flag, yang ditampilkan dalam keluaran bantuan perintah. Ini adalah dokumentasi opsional; host tidak memvalidasi maupun bertindak berdasarkannya.
typestringtidakJenis nilai flag — misalnya string, bool, atau int. Jika tidak ada, tidak ada klaim jenis.
defaultstringtidakNilai default flag ketika operator tidak memberikannya, dinyatakan sebagai string. Jika tidak ada, flag tidak mendeklarasikan nilai default.

Properti tambahan tidak diizinkan.

PluginDescriptorMeta

Metadata opsional tentang kepengarangan dan asal-usul build yang dideklarasikan plugin dalam describe(). Metadata ini bersifat informatif; host tidak memvalidasi maupun bertindak berdasarkannya. Field version dan commit adalah asal-usul build yang dicap ke dalam guest pada saat build; build tanpa cap menghilangkannya.

PropertiJenisWajibDeskripsi
authorstringtidakPembuat plugin.
repositorystringtidakRepositori sumber plugin.
licensestringtidakPengenal lisensi plugin.
versionstringtidakVersi asal-usul build yang dicap ke dalam guest pada saat build. Dihilangkan oleh build tanpa cap.
commitstringtidakCommit pendek asal-usul build yang menjadi dasar pembuatan guest. Dihilangkan oleh build tanpa cap.

Properti tambahan tidak diizinkan.

ProviderContract

Deklarasi diri provider tentang perilaku render waktu kompilasi yang dilakukannya pada node yang dirender — jenis input yang diterimanya, apakah dan bagaimana ia merakit keluaran per node dari sebuah grup dispatch menjadi satu artefak, pasangan delimiter Go-template yang diterapkannya pada file artefak yang diimpor, apakah ia menerima file yang dikontribusikan sebuah Recipe ke keluaran bersama boundary-nya, serta file yang tidak pernah dikirim ekosistemnya di samping sebuah sumber. Deklarasi ini menggambarkan provider secara keseluruhan, bukan satu export tertentu. Gerbang pemuatan memeriksa silang deklarasi ini terhadap klaim yang ditulis pada entitas.

PropertiJenisWajibDeskripsi
input_kindsInputKindsyaManakah dari tiga jenis input Recipe yang dirender plugin: kumpulan file bersumber, workload yang disintesis, dan node mandiri yang hanya berisi artefak.
boundary_assemblystring (enum)yaCara plugin menggabungkan keluaran render per node dari sebuah grup dispatch: none menulis keluaran setiap node langsung di jalur dispatch, merge melipat fragmen per node menjadi satu dokumen, dan nest menempatkan keluaran setiap node di posisinya sendiri dalam sebuah struktur payung. Nilai kosong tidak membawa klaim perakitan. Nilai yang diizinkan: "none", "merge", "nest", ""
artifact_delimitersArtifactDelimiterstidakPasangan delimiter Go-template yang diterapkan plugin pada file artefak yang diimpor. Jika tidak ada, digunakan pasangan pembuka/penutup default; plugin yang sintaksis targetnya bertabrakan dengan pasangan tersebut melaporkan pasangan alternatif di sini.
assembly_name_annotationAssemblyNameAnnotationtidakAnotasi boundary yang nilai terselesaikannya menamai artefak yang dirakit plugin dari sebuah grup dispatch. Jika tidak ada, plugin menamai hasil rakitannya hanya dari jalur dispatch.
reusable_instancebooleantidakApakah satu instans plugin yang dimuat dapat melayani setiap persilangan render, assemble, dan validate dalam build, alih-alih satu instans baru per persilangan. Plugin mendeklarasikannya true hanya jika tidak menyimpan state antar persilangan. Jika tidak ada (false), itulah default yang aman: host memuat instans baru per persilangan.
cross_boundary_linkingbooleantidakApakah plugin menghubungkan edge uses lintas boundary — edge yang ujung pemakai dan ujung yang dipakainya dirakit ke dalam grup dispatch yang berbeda — dengan menghasilkan pengkabelan referensi silang asli provider melalui export link_publish dan link_resolve miliknya. Plugin mendeklarasikannya true hanya jika mengekspor keduanya. Jika tidak ada (false), itulah default yang aman: plugin tidak menghubungkan edge lintas boundary apa pun.
omitsbooleantidakApakah plugin mematuhi entri omit yang dibawa input render_node: plugin mengecualikan setiap unit yang dirender yang cocok dengan sebuah entri dari semua yang dikembalikannya, dan melaporkan satu hitungan per entri yang diterimanya dalam omitted pada keluaran. Plugin mendeklarasikannya true hanya jika melakukan keduanya. Jika tidak ada (false), itulah default yang aman: plugin tidak mengklaim mengecualikan apa pun.
boundary_artifactsbooleantidakApakah target plugin menerima file yang dikontribusikan sebuah Recipe ke keluaran bersama boundary tempat plugin merender. Host mengevaluasi file tersebut dan menulis masing-masing satu kali, di direktori yang memuat keluaran rakitan grup dispatch, di samping apa yang ditulis oleh perakitan plugin; plugin tidak menerima satu pun file tersebut dan tidak membaca satu pun, sehingga klaim ini adalah pernyataan bahwa targetnya memperlakukan file yang ditempatkan di sana sebagai bagian dari keluaran boundary. Jika tidak ada (false), itulah default yang aman: Recipe yang mendeklarasikan file semacam itu untuk plugin ini ditolak sebelum apa pun dirender.
nest_segmentstringtidakDirektori tempat target plugin menempatkan sub-direktori milik setiap kontributor, untuk plugin yang menyarangkan keluaran per node dari sebuah grup dispatch. Host menggabungkan segmen ini, nama tingkat penulisan kontributor, dan jalur masing-masing file. Hanya dibaca ketika boundary_assembly bernilai nest. Jika tidak ada, host menempatkan sub-direktori setiap kontributor langsung di posisi dispatch, tanpa direktori pembungkus. Nilai ini menamai satu direktori dan tidak pernah sebuah jalur: nilai yang mengandung pemisah jalur, atau yang menamai direktori saat ini atau direktori induk, ditolak, karena host menyusun nama kontributor ke dalamnya dan fragmen jalur akan menempatkan file kontributor di tempat lain selain di bawah posisi dispatch.
source_ignoreSourceIgnoretidakFile yang tidak pernah dikirim ekosistem plugin ini di samping sumber yang direndernya, dideklarasikan sebagai aturan ignore. Host membaca deklarasi ini ketika seorang penulis menyematkan Recipe atau FeatureRecipe yang kapabilitasnya dilayani plugin ini untuk mereka: host menyusun aturan ini bersama file ignore milik penulis, mencatat aturan gabungan tersebut dalam lock entitas di samping entitas, dan sejak itu setiap publikasi entitas, setiap perbandingan sumber lokalnya, dan setiap render-nya menerapkan aturan yang tercatat alih-alih menanyakan plugin lagi. Jadi, Recipe yang dipublikasikan untuk sebuah kapabilitas membawa file yang dipertahankan oleh aturan penerbitnya, dan plugin merendernya jika plugin menggunakan versi ABI yang sama, kontraknya cocok dengan klaim entitasnya, dan plugin tidak memerlukan file di luar kumpulan tersebut. Plugin yang memerlukan file yang tidak disertakan dalam kumpulan tersebut harus menggagalkan build-nya secara jelas dan menyebutkan file tersebut; bagian host adalah menolak pengemasan atau pembacaan file yang tidak ada dalam kumpulan, dengan menyebutkannya. Jika tidak ada, tidak ada aturan ignore yang dideklarasikan, dan sumber yang dirender plugin kemudian mempertahankan setiap file yang dipertahankan oleh aturan milik penulis.

Properti tambahan tidak diizinkan.

SourceIgnore

Aturan ignore yang diterapkan ekosistem plugin pada sebuah direktori sumber, dalam sintaksis gitignore: pola yang tidak mengandung garis miring, atau hanya garis miring di akhir, cocok dengan nama pada kedalaman berapa pun; pola yang mengandung garis miring lainnya dibaca dari root direktori yang menjadi cakupannya; garis miring di akhir hanya cocok dengan direktori; dan tanda ! di awal mengembalikan apa yang dikecualikan oleh aturan sebelumnya. Aturan diterapkan secara berurutan dan kecocokan yang lebih akhir menimpa yang lebih awal. Direktori yang dikecualikan sebuah aturan tidak dimasuki, sehingga tidak ada isi di bawahnya yang kembali kecuali direktori itu sendiri dikembalikan terlebih dahulu.

PropertiJenisWajibDeskripsi
patternsstring[]tidakPola ignore milik ekosistem, masing-masing dengan cakupan root direktori sumber lokal yang sedang ditelusuri, dalam urutan penerapannya. Jika tidak ada atau kosong, tidak ada yang dideklarasikan.
filesstring[]tidakNama file ignore yang dipatuhi ekosistem di dalam sebuah sumber — misalnya .helmignore untuk sebuah chart. Di mana pun penelusuran sumber menemukan file dengan salah satu nama ini, baris-barisnya dibaca sebagai pola tambahan dalam sintaksis yang sama, masing-masing dengan cakupan direktori yang memuat file tersebut, dan diterapkan setelah pola di atas; baris kosong dan baris yang diawali # dilewati. File dengan nama tersebut ikut dibawa kecuali sebuah aturan mengecualikannya. Jika tidak ada atau kosong, tidak ada nama yang disebutkan.

Properti tambahan tidak diizinkan.

InputKinds

Jenis input Recipe mana yang dirender oleh sebuah plugin. Setiap field merupakan klaim yang independen; sebuah plugin dapat melaporkan kombinasi apa pun.

PropertiJenisWajibDeskripsi
sourcedbooleanyaApakah plugin merender kumpulan file bersumber (sebuah chart, sebuah modul, sebuah file compose).
synthesizedbooleanyaApakah plugin merender workload yang disintesis.
artifacts_standalonebooleanyaApakah plugin merender node mandiri yang hanya berisi artefak — node yang membawa dokumen artefak impor dan tidak memiliki sumber maupun workload.

Properti tambahan tidak diizinkan.

ArtifactDelimiters

Pasangan delimiter Go-template yang diterapkan plugin pada file artefak impor, dilaporkan jika berbeda dari pasangan default.

PropertiJenisWajibDeskripsi
leftstringyaDelimiter pembuka.
rightstringyaDelimiter penutup.

Properti tambahan tidak diizinkan.

AssemblyNameAnnotation

Anotasi batas yang nilai terselesaikannya menamai artefak hasil perakitan sebuah plugin, dilaporkan ketika plugin menggabungkan batas-batas kontributor dari sebuah grup dispatch menjadi satu rakitan bernama.

PropertiJenisWajibDeskripsi
annotationstringyaKunci anotasi batas tempat plugin membaca nama artefak hasil perakitan.
require_uniquebooleantidakApakah setiap batas yang berkontribusi pada satu grup dispatch harus sepakat mengenai nilai terselesaikan anotasi tersebut. Jika true, grup yang batas-batas kontributornya menyelesaikan anotasi ke nilai yang berbeda akan menghentikan build; jika false, plugin menerima nilai terselesaikan yang pertama.

Properti tambahan tidak diizinkan.

ImporterContract

Apa yang dideklarasikan sebuah importer tentang format-formatnya di luar sekadar mengiklankannya: tanda tangan yang digunakan untuk mengenali sumber dengan format tersebut. Ketika sebuah impor tidak menyebutkan format, host membaca tanda tangan yang dicatat oleh setiap importer yang menjadi pilihan impor tersebut — importer dalam katalog workspace dan importer inti compiler, yang entitas Plugin-nya dibawa oleh biner — mencocokkan masing-masing dengan sumber tanpa mengetahui apa pun tentang format, dan membaca sumber sebagai format dari satu-satunya importer yang tanda tangannya cocok. Sumber yang tidak cocok dengan tanda tangan mana pun ditolak dengan meminta format, dan sumber yang cocok dengan tanda tangan dari lebih dari satu format ditolak dengan menyebutkan format-format tersebut. Entitas Plugin mencatat daftar yang sama, dan host menolak importer yang laporan describe()-nya berbeda dari catatan tersebut.

PropertiJenisWajibDeskripsi
detectDetectSignature[]tidakTanda tangan yang mengenali sumber dengan format importer ini, dalam urutan yang dideklarasikan; sebuah sumber dikenali jika salah satu di antaranya cocok dengannya. Sumber yang dikenali oleh sebuah importer dikenali sebagai setiap format yang diiklankan importer tersebut, sehingga importer yang mengiklankan lebih dari satu format akan mendapati setiap kecocokan ditolak karena ambigu, dan importer yang sumbernya harus dapat dikenali mengiklankan satu format. Jika tidak ada atau kosong, tidak ada tanda tangan yang dideklarasikan, dan format importer hanya dapat dicapai dengan menyebutkannya.

Properti tambahan tidak diizinkan.

DetectSignature

Satu cara sebuah sumber dikenali: sintaksis yang digunakan untuk membaca sumber, nama file yang dikenai tanda tangan, dan predikat yang harus dipenuhi pohon hasil penguraian. Tanda tangan ini cocok dengan file yang namanya cocok dengan salah satu pola filenya — atau, jika tidak mendeklarasikan pola, dengan sumber berupa satu file, apa pun namanya — yang byte-nya dapat diurai dalam sintaksisnya, dan yang pohon hasil penguraiannya memenuhi setiap predikatnya. Tanda tangan ini cocok dengan sebuah direktori jika cocok dengan salah satu file direktori tersebut yang dipilih oleh polanya, sehingga tanda tangan yang tidak mendeklarasikan pola tidak cocok dengan direktori mana pun.

PropertiJenisWajibDeskripsi
syntaxstringyaFormat sintaksis yang digunakan untuk mengurai sumber — misalnya json atau yaml — yaitu format yang diiklankan plugin parser sebagai parse:. Host mengurai sumber melalui parser yang disediakan katalog workspace untuk sintaksis tersebut, atau, untuk sintaksis yang tidak disediakan parsernya oleh katalog, melalui parser yang dibawa compiler, paling banyak satu kali berapa pun jumlah tanda tangan yang menyebutkan sintaksis tersebut, dan sumber yang tidak dapat diurai dalam sintaksis itu tidak cocok dengan tanda tangan mana pun yang menyebutkannya. Sintaksis yang parsernya tidak disediakan oleh keduanya menghentikan pengenalan dengan menyebutkan ketiadaan parser tersebut, alih-alih dilewati. Panjang minimal 1 karakter.
filesstring[]tidakPola nama file yang dikenai tanda tangan, dicocokkan dengan bagian akhir nama sumber dengan pemisahnya dibaca sebagai garis miring: pola satu segmen dicocokkan dengan nama file itu sendiri, dan pola beberapa segmen yang dipisahkan garis miring dicocokkan dengan segmen akhir jalurnya sebanyak itu, sehingga .vscode/mcp.json cocok dengan file bernama mcp.json di dalam direktori bernama .vscode. Di dalam sebuah segmen, * cocok dengan rangkaian karakter apa pun, ? cocok dengan satu karakter, dan […] cocok dengan satu karakter dari sebuah kelas. Tanda tangan berlaku jika ada pola yang cocok. Pola yang tidak terbentuk dengan benar ditolak saat pemuatan. Jika tidak ada atau kosong, tanda tangan diterapkan pada sumber berupa satu file, apa pun namanya, dan tidak pada file mana pun dari sebuah direktori. Pola dari tanda tangan sebuah importer juga menentukan file mana dari sebuah direktori yang diserahkan impor kepadanya.
matchPathMatch[]tidakPredikat yang harus dipenuhi pohon hasil penguraian, semuanya, dalam urutan yang dinyatakan. Jika tidak ada atau kosong, tidak ada yang dituntut dari pohon selain dapat diurai dalam sintaksis tersebut.

Properti tambahan tidak diizinkan.

PathMatch

Satu predikat atas pohon hasil penguraian: nilai yang dicapai sebuah jalur, jenis nilai yang harus dimilikinya, dan secara opsional sebuah string yang harus sama dengannya atau menjadi awalannya.

PropertiJenisWajibDeskripsi
pathstringyaLokasi dalam pohon yang diperiksa predikat, ditulis sebagai kunci yang digabungkan dengan titik dari puncak pohon: data.nodes menyebut anggota nodes dari objek data tingkat atas. Segmen yang ditulis sebagai bilangan bulat, 0 atau lebih, memilih posisi tersebut dalam sebuah array yang dihitung dari nol, sehingga nodes.0.type menyebut type dari node pertama; setiap segmen lainnya memilih anggota sebuah objek. Kunci yang mengandung titik tidak dapat disebutkan. Panjang minimal 1 karakter.
isstring (enum)yaApa yang harus dicapai jalur: present berlaku jika jalur mencapai nilai jenis apa pun, termasuk null; absent berlaku jika jalur tidak mencapai apa pun; object, array, string, number, dan boolean masing-masing berlaku jika jalur mencapai nilai dengan jenis tersebut. Nilai yang diizinkan: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstringtidakString yang harus sama persis dengan nilai yang dicapai jalur. Nilai yang bukan string tidak pernah sama dengannya. Paling banyak salah satu dari equals dan prefix dideklarasikan pada satu predikat, dan predikat yang mendeklarasikan keduanya ditolak saat pemuatan. Panjang minimal 1 karakter.
prefixstringtidakString yang harus menjadi awalan nilai yang dicapai jalur. Nilai yang bukan string tidak pernah diawali dengannya. Paling banyak salah satu dari equals dan prefix dideklarasikan pada satu predikat, dan predikat yang mendeklarasikan keduanya ditolak saat pemuatan. Panjang minimal 1 karakter.

Properti tambahan tidak diizinkan.