Skema Aggrega Wasm Linter Socket
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json
Bentuk wire yang dikonsumsi (LinterInput) dan dihasilkan (LinterOutput) oleh socket linter. Linter dijalankan pada saat publikasi terhadap pasangan entitas versi sebelumnya + versi yang diusulkan (aturan evolusi skema) dan pada saat lint workspace terhadap entitas individual (aturan struktural per aturan). Satu plugin Wasm yang dikirimkan menampung banyak aturan; plugin memilih aturan yang dijalankan berdasarkan LinterInput.rule_id. Skema ini adalah satu-satunya sumber kedua bentuk wire: tipe payload Go, Rust, dan TypeScript dihasilkan darinya ke dalam paket plugin-ABI bersama, dan setiap kit plugin mengekspor ulang tipe yang dihasilkan tersebut alih-alih mendeklarasikan salinannya sendiri.
Salah satu dari bentuk berikut
LinterInputLinterOutput
Definisi
LinterInput
Payload yang diserahkan host kepada plugin publishing-linter pada setiap pemanggilan. rule_id memilih aturan yang menjadi tujuan dispatch plugin. entity_kind mengidentifikasi jenis entitas yang sedang di-lint (Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate). proposed membawa struktur entitas hasil parsing yang sedang diklasifikasikan (host mem-parsing YAML menjadi JSON sebelum mengirim; plugin tidak pernah melihat byte mentah). previous membawa entitas versi sebelumnya hasil parsing untuk aturan schema-evolution; dihilangkan bila tidak berlaku. implemented_component membawa entitas terkait dari jenis yang berbeda — Component yang direalisasikan oleh Recipe yang di-lint — untuk aturan yang membandingkan suatu entitas dengan kontrak yang dideklarasikan entitas lain; dihilangkan bila tidak berlaku. release dan components membawa sisa sebuah Release untuk aturan yang membacanya secara utuh — proposed kemudian adalah Aggregate yang di-deploy oleh Release tersebut, release adalah Release itu, dan components adalah Component yang menjadi tipe dari setiap instans komponen Aggregate; keduanya dihilangkan pada setiap input lainnya. policies membawa konfigurasi disiplin publikasi per workspace yang dirujuk oleh aturan.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
rule_id | string | ya | Aturan yang menjadi tujuan dispatch plugin, dinamai dengan id aturannya — pengenal kebab-case yang sama dengan yang dibawa temuan hasilnya dalam rule_id, sehingga aturan yang disupresi atau dilaporkan dinamai dengan cara yang sama di setiap permukaan. Himpunan yang dikenali adalah apa pun yang di-dispatch oleh plugin yang dirilis; id aturan yang tidak dikenali plugin menghasilkan temuan ‘unknown_rule’, bukan lolos secara diam-diam. |
entity_kind | string (enum) | ya | Jenis entitas yang dikodekan oleh nilai proposed/previous. Klasifikasi aturan schema-evolution bervariasi per jenis; aturan struktural dibatasi pada jenis tertentu. Nilai yang diizinkan: "Component", "Feature", "Recipe", "FeatureRecipe", "SchemaLibrary", "MappingLibrary", "Aggregate" |
proposed | object | ya | Struktur hasil parsing dari entitas yang sedang diklasifikasikan. Host mengonversi YAML menjadi JSON sebelum mengirim, sehingga plugin menerima nilai yang sudah terstruktur dan tidak pernah melihat byte mentah. Pada input aturan yang membaca sebuah Release secara utuh, ini adalah Aggregate yang di-deploy oleh Release tersebut. Pada setiap input, setiap nilai parameter dihapus sebelum entitas diserahkan, karena nilai sebuah parameter dapat berupa kredensial itu sendiri, sehingga tidak ada nilai parameter yang sampai ke plugin linter melalui field ini. Sebuah Aggregate mempertahankan deklarasi spec.parameters-nya, masing-masing hanya memuat kunci yang diterima skema Aggregate pada deklarasi parameter selain default, dan setiap deklarasi yang bersarang di bawah properties, items, dan valuesType diperlakukan sama: default dihapus, bukan diganti, sehingga plugin tidak dapat mengetahui apakah suatu deklarasi memberikannya, dan kunci yang tidak diterima skema di tempat itu dihapus beserta apa pun isinya. Blok parameters dari setiap modul di bawah spec.aggregates, yang membawa nilai yang diteruskan ke modul tersebut, dihapus seluruhnya, demikian pula spec.parameters pada entitas dari jenis lain apa pun. Teks templat yang membaca sebuah parameter dipertahankan sebagaimana ditulis. |
previous | object | tidak | Struktur hasil parsing dari entitas versi sebelumnya, untuk aturan yang melakukan perbandingan berpasangan (schema-evolution), dengan nilai parameternya dihapus persis seperti dari proposed. Dihilangkan bila aturan tidak memerlukan rujukan versi sebelumnya (misalnya, publikasi pertama, aturan yang hanya struktural). |
implemented_component | object | tidak | Struktur hasil parsing dari Component yang dinamai oleh Recipe yang di-lint dalam spec.implements, yang diresolusi oleh host. Ini adalah entitas terkait dari jenis yang BERBEDA dengan yang sedang di-lint, dan itulah yang membedakannya dari previous: previous membawa versi lain dari entitas yang sama, sedangkan ini membawa Component yang kontrak output terdeklarasinya direalisasikan oleh Recipe. Host meresolusinya melalui pencarian katalog yang sama dengan yang digunakan build, dengan kunci nama Component, sehingga ketiga bentuk pin yang diterima spec.implements (tanpa versi, eksak, rentang kompatibel major) mencapai entri yang sama. Dihilangkan bila entitas yang di-lint bukan Recipe, bila entitas itu tidak menamai Component, atau bila tidak ada Component dengan nama tersebut yang dapat dijangkau di direktori katalog workspace. Nilai yang tidak ada berarti perbandingan tidak tersedia, bukan berarti kontraknya kosong: aturan yang membaca field ini tidak menghasilkan temuan bila field ini tidak ada. |
release | object | tidak | Struktur hasil parsing dari Release yang dinamai oleh lint berlingkup release, dengan rantai extends-nya digabungkan, sehingga Release turunan membawa apa yang diwarisinya dari basisnya. Host mengonversinya dari YAML menjadi JSON seperti halnya proposed. Blok spec.parameters-nya memuat nilai yang memenuhi parameter Aggregate, sehingga blok itu dihapus seluruhnya sebelum Release diserahkan: nilai sebuah parameter dapat berupa kredensial itu sendiri, tidak ada aturan yang membaca blok itu, sehingga tidak ada nilai parameter yang sampai ke plugin linter melalui field ini. Hanya ada pada input aturan yang membaca sebuah Release secara utuh, dengan proposed adalah Aggregate yang di-deploy oleh Release ini, dengan nilai parameternya dihapus seperti dijelaskan pada proposed; dihilangkan pada setiap input lainnya. |
components | map of object | tidak | Component yang menjadi tipe dari setiap instans komponen Aggregate, dengan kunci nama instans yang diberikan Aggregate kepadanya, yaitu kunci yang sama dengan yang digunakan map components milik Aggregate dan milik Release sendiri. Setiap nilai adalah Component yang menjadi hasil resolusi type instans, dengan rantai extends apa pun digabungkan, dikonversi menjadi JSON seperti halnya implemented_component. Instans yang Component-nya tidak dapat dijangkau di direktori katalog workspace tidak ada, dan aturan membaca ketiadaan itu sebagai tidak tersedia, bukan sebagai Component yang tidak mendeklarasikan apa pun. Hanya ada bersama release, pada input aturan yang membaca sebuah Release secara utuh; dihilangkan pada setiap input lainnya. |
source_path | string | tidak | Path sistem berkas tempat entitas dimuat. Diisi oleh pemanggil host yang menelusuri sistem berkas katalog; digunakan oleh aturan yang sadar path (misalnya, category-matches-directory). Dihilangkan bila pemanggil tidak memiliki konteks path. |
policies | Policies | tidak | Konfigurasi disiplin publikasi per workspace yang dirujuk oleh aturan, dibawa sebagai objek Policies yang disusun host dari konfigurasi workspace dan override baris perintah apa pun. |
Properti tambahan tidak diizinkan.
LinterOutput
Bentuk respons yang dihasilkan plugin publishing-linter. findings membawa satu entri per pemanggilan aturan yang menghasilkan hasil. Aturan schema-evolution menghasilkan tepat satu temuan (putusan klasifikasi); aturan struktural dapat menghasilkan nol (tanpa pelanggaran) atau banyak (satu per pelanggaran).
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
findings | Diagnostic[] | ya | Temuan per aturan yang dihasilkan oleh pemanggilan plugin, dalam urutan emisi plugin. |
error | string | tidak | Pesan kegagalan yang diisi ketika guest berjalan tetapi tidak dapat menyelesaikan operasi; tidak ada jika berhasil. Ini berbeda dari diagnostik apa pun yang dibawa output: diagnostik melaporkan masalah yang ditemukan selama run yang tetap menghasilkan hasil, sedangkan error melaporkan bahwa operasi itu sendiri tidak selesai. Host menampilkan error yang ada sebagai pemanggilan plugin yang gagal. |
Properti tambahan tidak diizinkan.
Policies
Konfigurasi disiplin penerbitan per workspace yang dirujuk oleh kumpulan aturan, disusun oleh host dari pengaturan disiplin penerbitan pada konfigurasi workspace dan dari setiap penimpaan baris perintah. Skema ini adalah kontrak untuk bentuknya. Jika suatu field dihilangkan, setiap flag bernilai default false, dan host hanya menulis field yang nilainya bukan nilai default.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
allow_dynamic_refs | boolean | tidak | Jika true, penggunaan $dynamicAnchor / $dynamicRef dalam entri SchemaLibrary diizinkan (menonaktifkan aturan dynamic-refs). Default false. |
allow_id_overrides | boolean | tidak | Jika true, penimpaan $id dalam entri SchemaLibrary diizinkan (menonaktifkan aturan id-overrides). Default false. |
allow_direct_x_aggrega_extensions | boolean | tidak | Jika true, penulisan x-aggrega-selector / x-aggrega-inject secara langsung diizinkan (menonaktifkan aturan x-aggrega-discouragement). Default false. |
allow_aggrega_ai_prefix | boolean | tidak | Jika true, aturan annotation-prefix dinonaktifkan sepenuhnya (baik pemeriksaan aggrega.ai/ polos maupun pemeriksaan feature.aggrega.ai/ yang bergantung pada jenis). Default false. |
allow_nonstandard_names | boolean | tidak | Jika true, pelanggaran name-shape diizinkan (menonaktifkan aturan name-shape). Default false. |
allow_category_mismatches | boolean | tidak | Jika true, temuan aturan category-matches-directory dinonaktifkan. Konvensi katalog standar mengharuskan Components di bawah core/ |
allow_undeclared_recipe_provides | boolean | tidak | Jika true, temuan aturan provides-declared-by-component dinonaktifkan. Aturan tersebut melaporkan setiap kunci yang diterbitkan Recipe dalam spec.provides yang tidak dideklarasikan oleh Component yang dinamai dalam spec.implements-nya pada pilar provides dari spec.schema-nya. Penerbitan di luar kontrak yang dideklarasikan diterima saat build, sehingga temuan ini bersifat saran; workspace yang Recipes-nya sengaja menerbitkan kunci yang tidak dideklarasikan oleh Component-nya dapat memilih keluar di sini. Default false. |
allow_connection_credential_mismatches | boolean | tidak | Jika true, temuan aturan connection-credential-matches-target-key dinonaktifkan. Aturan tersebut membaca sebuah Release secara utuh dan, untuk setiap koneksi yang targetnya mendeklarasikan kunci yang diwajibkannya dari pemanggilnya, membandingkan kredensial yang diberikan koneksi dengan kunci yang dipegang target: aturan ini melaporkan dua ujung yang menyebut secret berbeda, serta kunci yang hanya dideklarasikan di salah satu ujung. Kesesuaian antara kedua ujung adalah konvensi katalog, bukan sesuatu yang diperiksa oleh build, sehingga temuan ini bersifat saran; workspace yang kedua ujungnya sengaja berbeda dapat memilih keluar di sini. Default false. |
Properti tambahan tidak diizinkan.