Aggrega Wasm eklentisi ortak tanılama şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json
Her Wasm soketinin paylaştığı tek tanılama biçimi. Bir eklenti, ortaya çıkardığı her sorun için bir girdi bildirir; ana makine bunu görünür kılar. Biçim bir üst kümedir: her soket kullandığı alt kümeyi doldurur ve geri kalanını atlar, böylece herhangi bir soketten gelen tanılama tek tip bir yapıdır. severity, her soketin paylaştığı üç değerden biridir (halt, warn veya info); böylece bir tanılama, hangi soket ortaya çıkarmış olursa olsun aynı anlamı taşır.
Üst düzey tür: object
Tanımlar
Diagnostic
Bir tanılama yayıcısının ortaya çıkardığı tek bir sorun: bir önem derecesi, insan tarafından okunabilir bir ileti, isteğe bağlı bir konum ve yayıcıya özgü isteğe bağlı alanlar. Yayıcı, bir Wasm eklenti soketi ya da derleyicinin kendisidir; ikisi de bu tek biçimle bildirir, böylece okuyucu bir girdiyi hangisi ortaya çıkarmış olursa olsun aynı şekilde yorumlar. Her biri kullandığı alt kümeyi doldurur ve geri kalanını atlar: bir ayrıştırıcı bir konum aralığı ayarlar, bir içe aktarma code ve source_ref ayarlar, bir yayımlama denetleyicisi rule_id ve classification ayarlar, bir yönetişim kararı derleme sonucunu belirleyen severity ve message değerlerini ayarlar ve code, rule_id, classification, source_ref, location ve suggest alanlarından herhangi birini ekleyebilir, bir işleme uyarısı ise code, source_ref ve yapılandırılmış bir konum ayarlar.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
severity | string (enum) | evet | Tanılamanın önem derecesi; her soketin paylaştığı kapalı tek bir kümeden alınır. halt derlemeyi durdurur ve neyin düzeltileceğini belirtir. warn, yine de tamamlanan bir derlemeyle birlikte görüntülenir. info gözlemi kaydeder ve derleme sonucunu değiştirmez. Her yayıcı bu tek kümeden bildirir, böylece okuyucu bir önem derecesini hangisi ortaya çıkarmış olursa olsun aynı şekilde yorumlar. İzin verilen değerler: "halt", "warn", "info" |
message | string | evet | İnsan tarafından okunabilir tanılama metni. |
code | string | hayır | Tanılama için, insan tarafından okunabilir iletiden bağımsız, isteğe bağlı, kararlı ve makinece eşleştirilebilir bir kod. Yayıcı kod atamadığında yoktur. Kod bir eklenti soketinden ya da derleyicinin kendi uyarılarından gelebilir; bu uyarılar ortaya çıkardıkları her girdiye bir kod atar. |
rule_id | string | hayır | Yayıcı kural tabanlı olduğunda (bir yayımlama denetleyicisi) tanılamayı üreten kuralın tanımlayıcısı. Aksi halde yoktur. |
classification | string (enum) | hayır | Yayan kural bir sınıflandırma atadığında (bir şema evrimi kuralı) tanılamanın taşıdığı anlamsal sürüm etkisi sınıflandırması. Sınıflandırma taşımayan tanılamalarda yoktur. İzin verilen değerler: "PATCH", "MINOR", "MAJOR" |
source_ref | string | hayır | Tanılamanın ilgili olduğu kaynak öğeye opak bir başvuru (örneğin bir içe aktarmanın çözümleyemediği bir kaynak düğümün tanımlayıcısı). Tanılama belirli bir kaynak öğeye başvurmadığında yoktur. |
location | Location | hayır | Yayıcı sorunun yerini belirleyebildiğinde tanılamanın işaret ettiği yer. Bir ayrıştırıcı bayt aralığını doldurur; bir işleyici bir kaynak belge içindeki yapılandırılmış konumu doldurur. Tanılamanın konumu olmadığında yoktur. |
suggest | string | hayır | Yayıcının tanılamayla birlikte sunduğu isteğe bağlı bir düzeltme ipucu. İpucu sunulmadığında yoktur. |
Ek özelliklere izin verilmez.
Location
Bir tanılamanın işaret ettiği yer. Hem ham kaynak metinde bayt düzeyinde kesin bir konuma (ayrıştırıcı span’i doldurur) hem de bir kaynak belge içindeki yapılandırılmış bir konuma (işleyici key_path, uri, line ve kind’ı doldurur) hizmet eden tek bir birleşik konum belirleyici taşır ve, varsa, tanılamanın ilgili olduğu derleme örneğini adlandırır (instance). Her alan isteğe bağlıdır; bir soket üretebildiği gösterimi doldurur ve geri kalanını atlar.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
span | Span | hayır | Yayıcı kaynağı ayrıştırıp sorunu bir bayt aralığına sabitleyebildiğinde (bir ayrıştırıcı) tanılamanın konumlandırdığı ham kaynak baytları aralığı. Aksi halde yoktur. |
key_path | string | hayır | Yayıcı sorunu yapısal olarak konumlandırdığında (bir işleyici) yapılandırılmış bir kaynak belge içindeki sorunlu öğeye giden noktalı bir yol. Aksi halde yoktur. |
uri | string | hayır | Yayıcı bildiğinde (bir işleyici) tanılamanın ilgili olduğu kaynak yapıtın tanımlayıcısı. Aksi halde yoktur. Asla bir derleme örneğini adlandırmaz; bunu instance taşır. |
line | integer | hayır | Yapılandırılmış kaynak belge içindeki bir satır numarası; span’in taşıdığı ham bayt satır ve sütunundan ayrıdır. Yayıcı bir belge satırını bildiğinde (bir işleyici) bulunur. Aksi halde yoktur. |
kind | string | hayır | Yayıcı yüzeyleri ayırt ettiğinde (bir işleyici) konumun başvurduğu kaynak yüzeyi adlandıran açık bir dize. Aksi halde yoktur. |
instance | string | hayır | Tanılamanın ilgili olduğu derleme örneği, derlemenin ona verdiği kimlikle: bir bileşen Aggregate’in onu bildirdiği adla, bir modülün katkıda bulunduğu bir bileşen modül boyunca noktalarla ayrılmış yoluyla, derlemenin türettiği bir bileşen derlemenin onun için oluşturduğu kimlikle ve bir modül kendi yoluyla. Tanılama tek bir örnekle ilgili olduğunda bulunur; aksi halde yoktur. |
Ek özelliklere izin verilmez.
Span
Özgün kaynak baytlarının bir aralığı: bayt uzaklıkları birincil ve kesin konumdur; satır ve sütun numaraları insan tarafından okunabilir tanılamalar için bunlara eşlik eder.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
start_offset | integer | evet | Aralığın ilk baytının özgün kaynaktaki sıfır tabanlı bayt uzaklığı. |
end_offset | integer | evet | Aralığın son baytının bir sonrasının özgün kaynaktaki bayt uzaklığı; böylece end_offset eksi start_offset, aralığın bayt cinsinden uzunluğudur. |
start_line | integer | evet | Aralığın başlangıcının bir tabanlı satır numarası; insan tarafından okunabilir tanılamalar içindir. |
start_column | integer | evet | Aralığın başlangıcının bir tabanlı sütun numarası; insan tarafından okunabilir tanılamalar içindir. |
end_line | integer | evet | Aralığın sonunun bir tabanlı satır numarası; insan tarafından okunabilir tanılamalar içindir. |
end_column | integer | evet | Aralığın sonunun bir tabanlı sütun numarası; insan tarafından okunabilir tanılamalar içindir. |
Ek özelliklere izin verilmez.