İçeriğe geç
AggregaAggrega
Dil seçin: Türkçe
Bu sayfa makine çevirisiyle çevrilmiştir. İngilizce orijinalini okuyun.

Aggrega Wasm Describe Socket şeması

Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.

Şema kimliği: https://aggrega.ai/schemas/wasm-describe-v1beta1.schema.json

Her Wasm eklentisinin describe() dışa aktarımından döndürdüğü aktarım biçimi (PluginDescriptor). describe(), eklentinin kendi beyanıdır ve ana makine eklentiyi yüklerken bir kez okunur: konuğun bağlandığı ABI sürümü, eklenti türü, her dışa aktarımın yetenek beyanıyla birlikte sunduğu dışa aktarımlar, eklenti düzeyinde bir yetenek öz bildirimi, isteğe bağlı bir sağlayıcı işleme davranışı sözleşmesi, isteğe bağlı bir içe aktarıcı tanıma sözleşmesi, isteğe bağlı CLI komutları, isteğe bağlı bir ayarlar şeması ve isteğe bağlı yazarlık meta verileri. Tek bir biçim her eklenti türünü kapsar: sağlayıcı, linter, feature-recipe-pipeline adımı, yönetişim, CLI, ayrıştırıcı ve içe aktarıcı. Ana makine, başka herhangi bir dışa aktarımı çağırmadan önce describe() sonucunu okur ve kabul edemediği bir tanımlayıcıyı, eklentiyi çağırma sırasında yanlış çağırmak yerine reddeder.

Aşağıdaki biçimlerden biri

  • PluginDescriptor

Tanımlar

PluginDescriptor

Bir plugin’in describe() tarafından döndürülen ve yüklemede bir kez okunan eksiksiz öz bildirimi. ABI uyumluluğu el sıkışmasını, plugin türünü, sunulan dışa aktarımları ve isteğe bağlı türe özgü yüzeyleri (bir provider’ın işleme davranışı sözleşmesi, bir importer’ın tanıma sözleşmesi, bir CLI plugin’inin komutları, bir ayar şeması, yazarlık meta verileri) taşır.

ÖzellikTürZorunluAçıklama
abi_versionconst “v1beta1”evetKonuğun bağlandığı plugin ABI’si. Host tam olarak bu sürümü kabul eder; başka bir ABI’ye karşı derlenmiş bir konuk, dağıtımda yanlış çağrılmak yerine yüklemede reddedilir. Sabit: "v1beta1"
plugin_typestring (enum)evetPlugin’in türü. Host’un doğruladığı asgari dışa aktarım kuralını ve dışa aktarım adıyla birlikte varsayılan girdi teslim desenini seçer. Bir governance plugin’i, derleme hattının dönüştürme ve karar rollerine hizmet eder; neyi üretebileceğini türü değil, bağlandığı rol belirler. İzin verilen değerler: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer"
capabilitiesstring[]hayırPlugin’in neye hizmet ettiği. Liste aktarımda düzdür ve yanındaki zorunlu plugin_type, her girdinin dört anlamdan hangisini taşıdığını belirler: bir provider için, çıktı biçimini oluşturduğu yetenek adları (helm veya compose gibi); bir feature-recipe-pipeline adımı için, adımının uyumlu olduğu provider yetenekleri; bir parser için, kanonik yapılandırılmış bir ağaca dönüştürdüğü kaynak biçimleri, her biri parse: olarak yazılır; bir importer için, taslak yazım dosyalarına dönüştürdüğü yabancı kaynak biçimleri, her biri import: olarak yazılır. Bir linter, governance veya CLI plugin’i yeteneğe göre çözümlenmez ve bunu boş bırakır. Girdiler bildirilen sıradadır ve açık, test edilmiş bir uyumluluk iddiasıdır. Bulunmayan veya boş bir liste hiçbir yetenek iddiası bildirmez. Yayımlanan katalog varlığı aynı değerleri, plugin türünün anlam kazandırdığı türe özgü blok altında taşır; böylece varlığı okuyanın hangi anlamın geçerli olduğuna hiçbir zaman karar vermesi gerekmez.
exportsPluginExport[]evetPlugin’in sunduğu dışa aktarımlar, bildirildikleri sırayla. Host, türe özgü asgari dışa aktarımın bulunduğunu doğrular ve her dışa aktarımı çağırmadan önce dışa aktarıma özgü host yüzeyini bağlar.
contractProviderContracthayırProvider’ın işleme davranışı öz raporu — işlediği girdi türleri, bir dağıtım grubunun düğüm başına çıktısını nasıl birleştirdiği ve uyguladığı artifact şablonu ayırıcı çifti. Herhangi bir dışa aktarımı değil, provider’ı bir bütün olarak tanımlar. İşleme davranışı sözleşmesi bildirmeyen bir plugin için bulunmaz.
importerImporterContracthayırBir importer’ın, bir içe aktarma hiçbir biçim belirtmediğinde duyurduğu biçimlerdeki bir kaynağın nasıl tanındığına dair öz raporu. Bunu yalnızca plugin_type değeri importer olan bir plugin bildirebilir; bunu bildiren başka herhangi bir plugin yüklemede reddedilir. Biçimlerini tanımanın hiçbir yolunu bildirmeyen bir importer için bulunmaz; bu durumda biçimlerine yalnızca adları belirtilerek ulaşılır.
descriptionstringhayırPlugin’in ne yaptığına dair kendi tek satırlık, insanların okuyabileceği açıklaması; dışa aktarıma özgü bir açıklamadan ve varlığın meta veri açıklamasından ayrıdır. Bilgi amaçlıdır; host bunu ne doğrular ne de buna göre işlem yapar.
commandsPluginCLICommand[]hayırBir CLI plugin’inin katkıda bulunduğu, her biri kendi kısa yardım satırına sahip üst düzey aggrega komut fiilleri. Bir CLI plugin’i birden çok komuta katkıda bulunabilir; host her girdi için bir komut kaydeder ve çağrı sırasında çözümlenen komut adını konuğa yönlendirir. CLI olmayan bir plugin bunu boş bırakır.
settings_schemaobjecthayırBir plugin’in, bağlantısının taşıdığı, operatör tarafından sağlanan ayarları türlendirmek için bildirdiği isteğe bağlı bir JSON Schema belgesi. Bulunduğunda host bunu yüklemede derler ve plugin’i çağırmadan önce dağıtımda bağlantının ayarlarını buna karşı doğrular; uymayan ayarlar derlemeyi durdurur. Bulunmadığında plugin hiçbir biçim bildirmez ve ayarlar olduğu gibi geçer. Şema, plugin’in kendi serbest biçimli bildirimidir; host buna karşı genel JSON Schema doğrulaması çalıştırır ve ayarların anlamını yorumlamaz.
metadataPluginDescriptorMetahayırİsteğe bağlı yazarlık ve derleme kökeni bilgileri. Hiçbir davranış sözleşmesi taşımaz — host bunu ne doğrular ne de buna göre işlem yapar.

Ek özelliklere izin verilmez.

PluginExport

Bir plugin’in describe() içinde bildirdiği şekliyle sunduğu bir dışa aktarım. Host, dışa aktarıma adıyla dağıtım yapar ve dışa aktarımın bildirilen host işlevlerinin gerektirdiği en az ayrıcalıklı host yüzeyini bağlar.

ÖzellikTürZorunluAçıklama
namestringevetDışa aktarımın ABI adı — örneğin render_node, assemble_boundary, lint_rules veya step. Host, dışa aktarıma bu adla dağıtım yapar.
input_patternstring (enum)hayırHost’un dışa aktarımın girdisini nasıl teslim ettiği: b, konuğun yalnızca yükten işleme yapabilmesi için tam yükü satır içi teslim eder; a, konuğun host işlevleriyle zenginleştirdiği küçük bir yük teslim eder. Bu alanı atlayan bir dışa aktarım, plugin türünün ve adının varsayılanını alır. İzin verilen değerler: "a", "b"
host_functionsstring[]hayırBu dışa aktarımın içe aktardığı host işlevi adları. Her ad host işlevi izin listesinde bulunmalıdır. Bildirim belirleyicidir ve yüklemede konuğun modülünden gerçekten içe aktardığı işlevlerle çapraz denetlenir; böylece konuğun gerçekten çağırdığı işlevlerden sapamaz.
descriptionstringhayırDışa aktarımı açıklayan, insanların okuyabileceği isteğe bağlı metin. Katalog okuyucuları için belgelemedir; host bunu ne doğrular ne de buna göre işlem yapar.
stabilitystring (enum)hayırDışa aktarımın kararlılık düzeyi. Atlanan bir değer hiçbir kararlılık iddiası taşımaz. İzin verilen değerler: "stable", "experimental", "deprecated"
operatesstring (enum)hayırBu dışa aktarımın gerçekleştirdiği hat işlemi: patch var olan işlenmiş bir belgeyi değiştirir, emit yeni bir belge ekler. Değerin biçimi yüklemede denetlenir; çalışma zamanı adımı dağıtırken bunu okur. İzin verilen değerler: "patch", "emit"
scopestring (enum)hayırBu dışa aktarımın üzerinde çalıştığı belge kökü: own düğümün kendi işlenmiş belgeleridir, host ise bileşen kapsamlı bir feature recipe’nin bağlı olduğu bileşenin belgeleridir. Değerin biçimi yüklemede denetlenir; çalışma zamanı dağıtım sırasında kapsamın belgelerini çözümler. İzin verilen değerler: "own", "host"
selectorstringhayırDışa aktarımın neyin üzerinde çalıştığına dair serbest biçimli, insanların okuyabileceği bir açıklama. Katalog okuyucuları için belgelemedir; host içeriğini ne doğrular ne de buna göre işlem yapar.
inputobjecthayırBir step dışa aktarımının, bir hat girdisinin with bloğu aracılığıyla sağladığı adıma özgü girdiyi türlendirmek için bildirdiği isteğe bağlı bir JSON Schema belgesi. Bulunduğunda, bir adımın with girdisinin karşıladığı biçimi tanımlar; bulunmadığında dışa aktarım hiçbir girdi sözleşmesi bildirmez. Şema, dışa aktarımın, bir hat yazarının bu dışa aktarım için hedeflediği girdi yüzeyine dair kendi serbest biçimli bildirimidir.
outputobjecthayırBir step dışa aktarımının bir adım için döndürdüğü çıktıları türlendirmek için bildirdiği isteğe bağlı bir JSON Schema belgesi — bir adımın, sonraki bir adımın veya bir şablonun okuması için sağladığı adreslenebilir çıktıların biçimi. Bulunduğunda bu döndürülen çıktıların biçimini tanımlar; bulunmadığında dışa aktarım hiçbir çıktı sözleşmesi bildirmez. Şema, dışa aktarımın, bu dışa aktarımın ürettiği çıktı yüzeyine dair kendi serbest biçimli bildirimidir.

Ek özelliklere izin verilmez.

PluginCLICommand

Bir CLI plugin’inin describe() içinde bildirdiği şekliyle katkıda bulunduğu bir üst düzey aggrega komut fiili. Host her girdi için bir komut kaydeder ve çağrı sırasında çözümlenen komut adını konuğa geri yönlendirir; böylece tek bir konuk birden çok komutu destekleyebilir ve davranışını ada göre seçebilir.

ÖzellikTürZorunluAçıklama
namestringevetHost’un kaydettiği komut fiili — bir operatörün çağırdığı aggrega belirteci ve host’un, hangi komutun çağrıldığına göre yönlendirme yapabilmesi için konuğa verdiği ayırt edici. Bildirilen her komut bunu belirtmelidir.
descriptionstringhayırKomutun, komut listesinde ve yardım çıktısında gösterilen tek satırlık kısa yardım metni. İsteğe bağlı belgelemedir; host bunu ne doğrular ne de buna göre işlem yapar.
flagsPluginCommandFlag[]hayırKomutun bayrakları, bildirildikleri sırayla. Her girdi, host’un komuta kaydettiği bir bayrağa katkıda bulunur; böylece aggrega help onu bir çekirdek komutun bayrağı gibi görüntüler. Bayrağı olmayan bir komut bunu boş bırakır.

Ek özelliklere izin verilmez.

PluginCommandFlag

Bir CLI plugin’inin bir komut üzerinde bildirdiği, describe() içinde raporlanan tek bir bayrak. Host bunu komuta kaydeder; böylece aggrega help onu bir çekirdek komutun bayraklarıyla birlikte listeler.

ÖzellikTürZorunluAçıklama
namestringevetBayrağın uzun adı — bir operatörün komut satırında verdiği —name belirteci. Bildirilen her bayrak bunu belirtmelidir. En az 1 karakter uzunluğunda.
shorthandstringhayırBayrağın isteğe bağlı, tek karakterlik kısa takma adı — bir operatörün uzun ad yerine verebileceği -x biçimi. Bulunmaması, bayrağın kısa takma adı olmadığı anlamına gelir.
descriptionstringhayırBayrağın komutun yardım çıktısında gösterilen tek satırlık yardım metni. İsteğe bağlı belgelemedir; host bunu ne doğrular ne de buna göre işlem yapar.
typestringhayırBayrağın değer türü — örneğin string, bool ya da int. Bulunmaması hiçbir tür iddiası taşımaz.
defaultstringhayırOperatör bayrağı vermediğinde kullanılan, string olarak ifade edilen varsayılan değer. Bulunmaması, bayrağın varsayılan değer bildirmediği anlamına gelir.

Ek özelliklere izin verilmez.

PluginDescriptorMeta

Bir plugin’in describe() içinde bildirdiği isteğe bağlı yazarlık ve derleme kökeni meta verileri. Bilgi amaçlıdır; host bunu doğrulamaz ve buna göre işlem yapmaz. version ve commit alanları, derleme zamanında guest’e işlenen derleme kökeni bilgileridir; işlenmemiş bir derleme bunları atlar.

ÖzellikTürZorunluAçıklama
authorstringhayırPlugin’in yazarı.
repositorystringhayırPlugin’in kaynak deposu.
licensestringhayırPlugin’in lisans tanımlayıcısı.
versionstringhayırDerleme zamanında guest’e işlenen derleme kökeni sürümü. İşlenmemiş bir derleme bunu atlar.
commitstringhayırGuest’in derlendiği, derleme kökenine ait kısa commit. İşlenmemiş bir derleme bunu atlar.

Ek özelliklere izin verilmez.

ProviderContract

Bir provider’ın, işlediği düğümler genelinde gerçekleştirdiği derleme zamanı işleme davranışlarına ilişkin kendi bildirimi — kabul ettiği girdi türleri, bir dağıtım grubunun düğüm başına çıktısını tek bir yapıta birleştirip birleştirmediği ve nasıl birleştirdiği, içe aktarılan yapıt dosyalarına uyguladığı Go şablonu sınırlayıcı çifti, bir Recipe’in sınırının paylaşılan çıktısına kattığı dosyaları kabul edip etmediği ve ekosisteminin bir kaynağın yanında hiçbir zaman göndermediği dosyalar. Provider’ı herhangi bir dışa aktarımı değil, bir bütün olarak tanımlar. Yükleme kapısı bunu varlığın yazılmış iddiasıyla çapraz denetler.

ÖzellikTürZorunluAçıklama
input_kindsInputKindsevetPlugin’in üç Recipe girdi türünden hangilerini işlediği: kaynaklı bir dosya kümesi, sentezlenmiş bir workload ve bağımsız, yalnızca yapıtlardan oluşan bir düğüm.
boundary_assemblystring (enum)evetPlugin’in bir dağıtım grubunun düğüm başına işleme çıktısını nasıl birleştirdiği: none her düğümün çıktısını doğrudan dağıtım yoluna yazar, merge düğüm başına parçaları tek bir belgede birleştirir, nest ise her düğümün çıktısını bir şemsiye yapı içinde kendi konumunun altına yerleştirir. Boş bir değer hiçbir birleştirme iddiası taşımaz. İzin verilen değerler: "none", "merge", "nest", ""
artifact_delimitersArtifactDelimitershayırPlugin’in içe aktarılan yapıt dosyalarına uyguladığı Go şablonu sınırlayıcı çifti. Bulunmaması varsayılan açma/kapama çifti anlamına gelir; hedef sözdizimi bu çiftle çakışan bir plugin burada alternatif bir çift raporlar.
assembly_name_annotationAssemblyNameAnnotationhayırÇözümlenen değeri, plugin’in bir dağıtım grubundan birleştirdiği yapıtı adlandıran bir sınır ek açıklaması. Bulunmaması, plugin’in birleştirmesini yalnızca dağıtım yolundan adlandırdığı anlamına gelir.
reusable_instancebooleanhayırYüklenmiş tek bir plugin örneğinin, her geçiş için yeni bir örnek yerine derlemenin her render, assemble ve validate geçişine hizmet edip edemeyeceği. Bir plugin bunu yalnızca geçişler arasında hiçbir durum tutmadığında true olarak bildirir. Bulunmaması (false) güvenli varsayılandır: host her geçiş için yeni bir örnek yükler.
cross_boundary_linkingbooleanhayırPlugin’in, link_publish ve link_resolve dışa aktarımları aracılığıyla provider’a özgü çapraz başvuru bağlantıları üreterek sınırlar arası uses kenarlarını — tüketen ve tüketilen uçları farklı dağıtım gruplarında birleşen kenarları — bağlayıp bağlamadığı. Bir plugin bunu yalnızca ikisini de dışa aktardığında true olarak bildirir. Bulunmaması (false) güvenli varsayılandır: plugin hiçbir sınırlar arası kenarı bağlamaz.
omitsbooleanhayırPlugin’in bir render_node girdisinin taşıdığı omit girdilerine uyup uymadığı: bir girdinin eşleştiği her işlenmiş birimi döndürdüğü her şeyin dışında bırakır ve kendisine verilen her girdi için çıktının omitted alanında bir sayı raporlar. Bir plugin bunu yalnızca ikisini de yaptığında true olarak bildirir. Bulunmaması (false) güvenli varsayılandır: plugin herhangi bir şeyi dışarıda bırakma iddiasında bulunmaz.
boundary_artifactsbooleanhayırPlugin’in hedefinin, bir Recipe’in plugin’in içinde işlediği sınırın paylaşılan çıktısına kattığı dosyaları kabul edip etmediği. Host bu dosyaları değerlendirir ve her birini, dağıtım grubunun birleştirilmiş çıktısını tutan dizine, plugin’in birleştirmesinin yazdıklarının yanına bir kez yazar; plugin’e bunlardan hiçbiri verilmez ve hiçbirini okumaz, dolayısıyla bu iddia, hedefinin oraya yerleştirilen bir dosyayı sınırın çıktısının parçası olarak ele aldığına dair bir beyandır. Bulunmaması (false) güvenli varsayılandır: bu plugin için bu tür dosyalar bildiren bir Recipe, herhangi bir şey işlenmeden önce reddedilir.
nest_segmentstringhayırBir dağıtım grubunun düğüm başına çıktısını iç içe yerleştiren bir plugin için, plugin’in hedefinin her katkıcının kendi alt dizinini altına yerleştirdiği dizin. Host bu segmenti, katkıcının yazım düzeyindeki adını ve her dosyanın kendi yolunu birleştirir. Yalnızca boundary_assembly nest olduğunda okunur. Bulunmadığında host, her katkıcının alt dizinini herhangi bir kapsayıcı dizin olmadan doğrudan dağıtım konumuna yerleştirir. Değer bir yolu değil, tek bir dizini adlandırır: yol ayırıcı taşıyan ya da geçerli veya üst dizini adlandıran bir değer reddedilir, çünkü host katkıcının adını bunun içine yerleştirir ve bir yol parçası, katkıcının dosyalarını dağıtım konumunun altı dışında bir yere yerleştirir.
source_ignoreSourceIgnorehayırBu plugin’in ekosisteminin, işlediği bir kaynağın yanında hiçbir zaman göndermediği, yok sayma kuralları olarak bildirilen dosyalar. Host bu bildirimi, bir yazar yeteneğine bu plugin’in kendisi için hizmet ettiği bir Recipe ya da FeatureRecipe sabitlediğinde okur: bu kuralları yazarın kendi yok sayma dosyasıyla birleştirir, birleştirilmiş kuralları varlığın yanındaki varlık kilidine kaydeder ve bundan sonra varlığın her yayımlanması, yerel kaynağının her karşılaştırılması ve her işlenmesi, bir plugin’e yeniden sormak yerine kaydedilen kuralları uygular. Böylece bir yetenek için yayımlanan bir Recipe, yayımlayanın kurallarının tuttuğu dosyaları taşır ve bir plugin onu, aynı ABI sürümünü konuştuğunda, sözleşmesi varlığının iddiasıyla eşleştiğinde ve bu kümenin dışında hiçbir dosyaya ihtiyaç duymadığında işler. Kümenin dışarıda bıraktığı bir dosyaya ihtiyaç duyan bir plugin, derlemesini açıkça başarısız kılmalı ve dosyayı adlandırmalıdır; host’un payına düşen, kümenin tutmadığı bir dosyanın paketlenmesini ya da okunmasını, dosyayı adlandırarak reddetmektir. Bulunmaması hiçbir yok sayma kuralı bildirmez ve plugin’in işlediği bir kaynak bu durumda yazarın kendi kurallarının tuttuğu her dosyayı korur.

Ek özelliklere izin verilmez.

SourceIgnore

Bir plugin’in ekosisteminin bir kaynak dizinine gitignore sözdiziminde uyguladığı yok sayma kuralları: hiç eğik çizgi içermeyen ya da yalnızca sonda eğik çizgi içeren bir desen herhangi bir derinlikteki bir adla eşleşir, başka herhangi bir eğik çizgi içeren bir desen kapsamlandığı dizinin kökünden itibaren okunur, sondaki eğik çizgi yalnızca bir dizinle eşleşir ve baştaki ! daha önceki bir kuralın dışladığını geri getirir. Kurallar sırayla uygulanır ve sonraki bir eşleşme öncekini geçersiz kılar. Bir kuralın dışladığı dizine girilmez; bu nedenle dizinin kendisi önce geri getirilmedikçe altındaki hiçbir şey geri gelmez.

ÖzellikTürZorunluAçıklama
patternsstring[]hayırEkosistemin, her biri dolaşılan yerel kaynak dizininin köküne kapsamlanmış, uygulandıkları sıradaki kendi yok sayma desenleri. Bulunmaması ya da boş olması hiçbirini bildirmez.
filesstring[]hayırEkosistemin bir kaynak içinde uyduğu yok sayma dosyalarının adları — örneğin bir chart için .helmignore. Bir kaynağın dolaşılması bu adlardan birine sahip bir dosya bulduğunda, dosyanın satırları aynı sözdiziminde ek desenler olarak okunur; her biri dosyayı tutan dizine kapsamlanır ve yukarıdaki desenlerden sonra uygulanır; boş bir satır ve # ile başlayan bir satır atlanır. Böyle bir ada sahip bir dosyanın kendisi, bir kural onu dışlamadıkça taşınır. Bulunmaması ya da boş olması hiçbirini adlandırmaz.

Ek özelliklere izin verilmez.

InputKinds

Bir plugin’in hangi Recipe girdi türlerini işlediği. Her alan bağımsız bir beyandır; bir plugin herhangi bir birleşimi bildirebilir.

ÖzellikTürZorunluAçıklama
sourcedbooleanevetPlugin’in kaynaklı bir dosya kümesini (bir chart, bir modül, bir compose dosyası) işleyip işlemediği.
synthesizedbooleanevetPlugin’in sentezlenmiş bir workload’u işleyip işlemediği.
artifacts_standalonebooleanevetPlugin’in bağımsız, yalnızca artifact içeren bir düğümü — içe aktarılmış artifact belgeleri taşıyan ve kaynak ya da workload taşımayan bir düğümü — işleyip işlemediği.

Ek özelliklere izin verilmez.

ArtifactDelimiters

Bir plugin’in içe aktarılmış artifact dosyalarına uyguladığı Go şablonu ayırıcı çifti; varsayılan çiftten farklı olduğunda bildirilir.

ÖzellikTürZorunluAçıklama
leftstringevetAçılış ayırıcısı.
rightstringevetKapanış ayırıcısı.

Ek özelliklere izin verilmez.

AssemblyNameAnnotation

Çözümlenen değeri bir plugin’in birleştirilmiş artifact’ını adlandıran sınır ek açıklaması; plugin bir dispatch grubunun katkıda bulunan sınırlarını adlandırılmış tek bir birleştirmede topladığında bildirilir.

ÖzellikTürZorunluAçıklama
annotationstringevetPlugin’in birleştirilmiş artifact’ın adını okuduğu sınır ek açıklaması anahtarı.
require_uniquebooleanhayırBir dispatch grubuna katkıda bulunan her sınırın ek açıklamanın çözümlenen değeri üzerinde uzlaşması gerekip gerekmediği. True olduğunda, katkıda bulunan sınırları ek açıklamayı farklı değerlere çözümleyen bir grup derlemeyi durdurur; false olduğunda plugin ilk çözümlenen değeri kabul eder.

Ek özelliklere izin verilmez.

ImporterContract

Bir içe aktarıcının biçimlerini duyurmanın ötesinde onlar hakkında bildirdiği şey: o biçimlerdeki bir kaynağın tanındığı imzalar. Bir içe aktarma hiçbir biçim belirtmediğinde host, içe aktarmanın aralarından seçim yaptığı her içe aktarıcının — çalışma alanının kataloğundaki içe aktarıcılar ile Plugin varlıklarını ikili dosyanın taşıdığı derleyicinin çekirdek içe aktarıcıları — kaydettiği imzaları okur, herhangi bir biçimin ne olduğunu bilmeden her birini kaynakla eşleştirir ve kaynağı, imzası eşleşen tek içe aktarıcının biçiminde okur. Hiçbir imzanın eşleşmediği bir kaynak biçim istenerek reddedilir; birden fazla biçimin imzalarının eşleştiği bir kaynak ise bu biçimler adlandırılarak reddedilir. Plugin varlığı aynı listeyi kaydeder ve host, describe() raporu bu kayıttan farklı olan bir içe aktarıcıyı reddeder.

ÖzellikTürZorunluAçıklama
detectDetectSignature[]hayırBu içe aktarıcının biçimlerindeki bir kaynağı tanıyan imzalar, bildirilen sırayla; bunlardan herhangi biri eşleştiğinde kaynak tanınır. Bir içe aktarıcının tanıdığı kaynak, içe aktarıcının duyurduğu her biçim olarak tanınır; bu nedenle birden fazla biçim duyuran bir içe aktarıcının her eşleşmesi belirsiz olarak reddedilir ve kaynaklarının tanınması gereken bir içe aktarıcı tek bir biçim duyurur. Bulunmaması ya da boş olması hiçbir imza bildirmez ve içe aktarıcının biçimlerine yalnızca adları belirtilerek ulaşılır.

Ek özelliklere izin verilmez.

DetectSignature

Bir kaynağın tanınma yollarından biri: kaynağın okunduğu sözdizimi, imzanın uygulandığı dosya adları ve ayrıştırılan ağacın karşılaması gereken yüklemler. Adı dosya kalıplarından biriyle eşleşen — ya da hiç kalıp bildirmediği durumda, adı ne olursa olsun tek bir dosya olan bir kaynak —, baytları kendi sözdiziminde ayrıştırılan ve ayrıştırılan ağacı yüklemlerinin her birini karşılayan bir dosyayla eşleşir. Bir dizinle, kalıplarının seçtiği dizin dosyalarından biriyle eşleştiğinde eşleşir; bu nedenle hiç kalıp bildirmeyen bir imza hiçbir dizinle eşleşmez.

ÖzellikTürZorunluAçıklama
syntaxstringevetKaynağın ayrıştırıldığı sözdizimsel biçim — örneğin json veya yaml — bir ayrıştırıcı plugin’in parse: olarak duyurduğu biçimdir. Host, kaynağı çalışma alanının kataloğunun o sözdizimi için sunduğu ayrıştırıcıyla ya da kataloğun hiçbir ayrıştırıcı sunmadığı bir sözdizimi için derleyicinin taşıdığı ayrıştırıcıyla, sözdizimini kaç imza adlandırırsa adlandırsın en fazla bir kez ayrıştırır; bu sözdiziminde ayrıştırılamayan bir kaynak, onu adlandıran hiçbir imzayla eşleşmez. İkisinin de ayrıştırıcı sunmadığı bir sözdizimi atlanmaz; tanımayı, o ayrıştırıcının yokluğunu adlandırarak durdurur. En az 1 karakter uzunluğundadır.
filesstring[]hayırİmzanın uygulandığı dosya adı kalıpları; ayırıcıları eğik çizgi olarak okunarak kaynağın adının sonuyla eşleştirilir: tek kesimli bir kalıp dosyanın kendi adıyla, eğik çizgiyle ayrılmış birden çok kesimli bir kalıp ise yolunun o sayıdaki son kesimiyle eşleştirilir; böylece .vscode/mcp.json, .vscode adlı bir dizindeki mcp.json adlı bir dosyayla eşleşir. Bir kesim içinde * herhangi bir karakter dizisiyle, ? tek bir karakterle, […] ise bir sınıftan tek bir karakterle eşleşir. Herhangi bir kalıp eşleştiğinde imza uygulanır. Düzgün biçimlendirilmemiş bir kalıp yüklemede reddedilir. Bulunmaması ya da boş olması, imzayı adı ne olursa olsun tek bir dosya olan kaynağa uygular ve bir dizinin hiçbir dosyasına uygulamaz. Bir içe aktarıcının imzalarındaki kalıplar, bir içe aktarmanın ona bir dizinin hangi dosyalarını vereceğini de belirler.
matchPathMatch[]hayırAyrıştırılan ağacın bildirilen sırayla, tümünü karşılaması gereken yüklemler. Bulunmaması ya da boş olması, ağaçtan sözdiziminde ayrıştırılmanın ötesinde hiçbir şey istemez.

Ek özelliklere izin verilmez.

PathMatch

Ayrıştırılan ağaç üzerinde bir yüklem: bir yolun ulaştığı değer, bu değerin olması gereken tür ve isteğe bağlı olarak değerin eşit olması ya da onunla başlaması gereken bir dize.

ÖzellikTürZorunluAçıklama
pathstringevetYüklemin ağacın neresine baktığı; ağacın tepesinden başlayarak noktalarla birleştirilmiş anahtarlar olarak yazılır: data.nodes, en üst düzeydeki data nesnesinin nodes üyesini belirtir. 0 ya da daha büyük bir tam sayı olarak yazılan kesim, bir dizinin sıfırdan sayılan o konumunu seçer; böylece nodes.0.type ilk düğümün type’ını belirtir; diğer her kesim bir nesnenin üyesini seçer. Kendisi nokta içeren bir anahtar belirtilemez. En az 1 karakter uzunluğundadır.
isstring (enum)evetYolun ulaşması gereken şey: present, yol null dahil herhangi bir türde değere ulaştığında sağlanır; absent, yol hiçbir şeye ulaşmadığında sağlanır; object, array, string, number ve boolean, yol o türde bir değere ulaştığında sağlanır. İzin verilen değerler: "present", "absent", "object", "array", "string", "number", "boolean"
equalsstringhayırYolun ulaştığı değerin tam olarak eşit olması gereken dize. Dize olmayan bir değer ona hiçbir zaman eşit olmaz. Bir yüklemde equals ve prefix’ten en fazla biri bildirilir; ikisini birden bildiren bir yüklem yüklemede reddedilir. En az 1 karakter uzunluğundadır.
prefixstringhayırYolun ulaştığı değerin başlaması gereken dize. Dize olmayan bir değer hiçbir zaman onunla başlamaz. Bir yüklemde equals ve prefix’ten en fazla biri bildirilir; ikisini birden bildiren bir yüklem yüklemede reddedilir. En az 1 karakter uzunluğundadır.

Ek özelliklere izin verilmez.