Skema diagnostik bersama plugin Wasm Aggrega
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json
Bentuk diagnostik tunggal yang digunakan bersama oleh setiap soket Wasm. Sebuah plugin melaporkan satu entri untuk setiap masalah yang dimunculkannya; host menampilkannya. Bentuk ini merupakan superset: setiap soket mengisi subset yang digunakannya dan menghilangkan sisanya, sehingga diagnostik dari soket mana pun memiliki satu struktur yang seragam. severity adalah salah satu dari tiga nilai yang digunakan bersama oleh setiap soket — halt, warn, atau info — sehingga diagnostik membawa makna yang sama, soket mana pun yang memunculkannya.
Jenis tingkat teratas: object
Definisi
Diagnostic
Satu masalah yang dimunculkan oleh pemancar diagnostik: tingkat keparahan, pesan yang dapat dibaca manusia, lokasi opsional, dan bidang opsional khusus pemancar. Pemancar adalah soket plugin Wasm atau kompiler itu sendiri — keduanya melaporkan dengan satu bentuk ini, sehingga pembaca menafsirkan entri dengan cara yang sama, mana pun yang memunculkannya. Masing-masing mengisi subset yang digunakannya dan menghilangkan sisanya: parser menetapkan rentang lokasi, impor menetapkan code dan source_ref, linter publikasi menetapkan rule_id dan classification, putusan tata kelola menetapkan severity dan message hasil build serta dapat menambahkan code, rule_id, classification, source_ref, location, dan suggest mana pun, dan saran render menetapkan code, source_ref, serta location terstruktur.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
severity | string (enum) | ya | Tingkat keparahan diagnostik, diambil dari satu himpunan tertutup yang digunakan bersama oleh setiap soket. halt menghentikan build dan menyebutkan apa yang harus diperbaiki. warn ditampilkan bersama build yang tetap selesai. info mencatat pengamatan dan membiarkan hasil build tidak berubah. Setiap pemancar melaporkan dari satu himpunan ini, sehingga pembaca menafsirkan tingkat keparahan dengan cara yang sama, mana pun yang memunculkannya. Nilai yang diizinkan: "halt", "warn", "info" |
message | string | ya | Teks diagnostik yang dapat dibaca manusia. |
code | string | tidak | Kode opsional yang stabil dan dapat dicocokkan mesin untuk diagnostik, terlepas dari pesan yang dapat dibaca manusia. Tidak ada jika pemancar tidak menetapkan kode. Kode dapat berasal dari soket plugin atau dari saran milik kompiler sendiri, yang menetapkan kode pada setiap entri yang dimunculkannya. |
rule_id | string | tidak | Pengidentifikasi aturan yang menghasilkan diagnostik, jika pemancar berbasis aturan (linter publikasi). Tidak ada jika sebaliknya. |
classification | string (enum) | tidak | Klasifikasi dampak versi semantik yang dibawa diagnostik, jika aturan pemancar menetapkannya (aturan evolusi skema). Tidak ada untuk diagnostik yang tidak membawa klasifikasi. Nilai yang diizinkan: "PATCH", "MINOR", "MAJOR" |
source_ref | string | tidak | Referensi buram ke elemen sumber yang menjadi perhatian diagnostik (misalnya pengidentifikasi node sumber yang tidak dapat diselesaikan oleh impor). Tidak ada jika diagnostik tidak mereferensikan elemen sumber tertentu. |
location | Location | tidak | Tempat yang ditunjuk diagnostik, jika pemancar dapat menemukan lokasi masalah. Parser mengisi rentang byte; renderer mengisi posisi terstruktur dalam dokumen sumber. Tidak ada jika diagnostik tidak memiliki lokasi. |
suggest | string | tidak | Petunjuk perbaikan opsional yang ditawarkan pemancar bersama diagnostik. Tidak ada jika tidak ada petunjuk yang ditawarkan. |
Properti tambahan tidak diizinkan.
Location
Tempat yang ditunjuk diagnostik. Objek ini membawa satu penunjuk lokasi terpadu yang melayani baik posisi tepat per byte dalam teks sumber mentah (parser mengisi span) maupun posisi terstruktur dalam dokumen sumber (renderer mengisi key_path, uri, line, dan kind), serta menyebutkan instans build yang menjadi perhatian diagnostik jika ada (instance). Setiap bidang bersifat opsional; soket mengisi representasi yang dapat dihasilkannya dan menghilangkan sisanya.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
span | Span | tidak | Rentang byte sumber mentah yang ditunjuk diagnostik, jika pemancar mengurai sumber dan dapat menetapkan masalah pada rentang byte (parser). Tidak ada jika sebaliknya. |
key_path | string | tidak | Jalur bertitik ke elemen bermasalah dalam dokumen sumber terstruktur, jika pemancar menemukan lokasi masalah secara struktural (renderer). Tidak ada jika sebaliknya. |
uri | string | tidak | Pengidentifikasi artefak sumber yang menjadi perhatian diagnostik, jika pemancar mengetahuinya (renderer). Tidak ada jika sebaliknya. Bidang ini tidak pernah menyebutkan instans build; instance yang membawanya. |
line | integer | tidak | Nomor baris dalam dokumen sumber terstruktur, berbeda dari baris dan kolom byte mentah yang dibawa oleh span. Ada jika pemancar mengetahui baris dokumen (renderer). Tidak ada jika sebaliknya. |
kind | string | tidak | String terbuka yang menyebutkan permukaan sumber yang dirujuk lokasi, jika pemancar membedakan permukaan (renderer). Tidak ada jika sebaliknya. |
instance | string | tidak | Instans build yang menjadi perhatian diagnostik, menurut identitas yang diberikan build kepadanya: komponen menurut nama yang dideklarasikan Aggregate untuknya, komponen yang disumbangkan sebuah modul menurut path-nya yang dipisahkan titik melalui modul tersebut, komponen yang diturunkan build menurut identitas yang disusun build untuknya, dan modul menurut path-nya sendiri. Ada jika diagnostik menyangkut satu instans; tidak ada jika sebaliknya. |
Properti tambahan tidak diizinkan.
Span
Rentang byte sumber asli: offset byte adalah lokasi utama yang tepat, dan nomor baris serta kolom menyertainya untuk diagnostik yang dapat dibaca manusia.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
start_offset | integer | ya | Offset byte dari byte pertama rentang dalam sumber asli, berbasis nol. |
end_offset | integer | ya | Offset byte satu setelah byte terakhir rentang dalam sumber asli, sehingga end_offset dikurangi start_offset adalah panjang rentang dalam byte. |
start_line | integer | ya | Nomor baris awal rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia. |
start_column | integer | ya | Nomor kolom awal rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia. |
end_line | integer | ya | Nomor baris akhir rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia. |
end_column | integer | ya | Nomor kolom akhir rentang, berbasis satu, untuk diagnostik yang dapat dibaca manusia. |
Properti tambahan tidak diizinkan.