Aggrega Wasm プラグイン共有診断スキーマ
自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。
スキーマ ID: https://aggrega.ai/schemas/wasm-diagnostic-v1beta1.schema.json
すべての Wasm ソケットが共有する単一の診断の形です。プラグインは発生させた問題ごとに 1 つのエントリを報告し、ホストがそれを表面化します。この形はスーパーセットです。各ソケットは使用するサブセットを設定し、残りを省略するため、どのソケットからの診断も 1 つの統一された構造になります。severity はすべてのソケットが共有する 3 つの値(halt、warn、info)のいずれかであり、どのソケットが発生させたかにかかわらず、診断は同じ意味を持ちます。
トップレベルの型: object
定義
Diagnostic
診断の発行元が発生させた 1 つの問題です。重大度、人間が読めるメッセージ、任意の位置、および発行元固有の任意のフィールドからなります。発行元は Wasm プラグインのソケットまたはコンパイラ自体であり、どちらもこの 1 つの形で報告するため、どちらが発生させたかにかかわらず、読み手はエントリを同じように解釈します。それぞれが使用するサブセットを設定し、残りを省略します。パーサーは位置のスパンを設定し、インポートは code と source_ref を設定し、公開リンターは rule_id と classification を設定し、ガバナンスの判定はビルド結果の重大度とメッセージを設定し、code、rule_id、classification、source_ref、location、suggest のいずれかを追加する場合があります。レンダリングの勧告は code、source_ref、および構造化された位置を設定します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
severity | string (enum) | はい | 診断の重大度で、すべてのソケットが共有する 1 つの閉じた集合から選ばれます。halt はビルドを停止し、修正すべき点を示します。warn は完了するビルドとともに表示されます。info は観察内容を記録し、ビルド結果を変更しません。すべての発行元がこの 1 つの集合から報告するため、どれが発生させたかにかかわらず、読み手は重大度を同じように解釈します。許可される値: "halt"、"warn"、"info" |
message | string | はい | 人間が読める診断テキストです。 |
code | string | いいえ | 診断に対する任意の安定した機械照合可能なコードで、人間が読めるメッセージとは独立しています。発行元がコードを割り当てない場合は存在しません。コードはプラグインのソケットから、またはコンパイラ自身の勧告から得られる場合があり、後者は発生させるすべてのエントリにコードを設定します。 |
rule_id | string | いいえ | 発行元がルールベース(公開リンター)である場合に、診断を生成したルールの識別子です。それ以外の場合は存在しません。 |
classification | string (enum) | いいえ | 発行元のルールが分類を割り当てる場合(スキーマ進化ルール)に、診断が持つセマンティックバージョンへの影響の分類です。分類を持たない診断では存在しません。許可される値: "PATCH"、"MINOR"、"MAJOR" |
source_ref | string | いいえ | 診断が対象とするソース要素への不透明な参照です(たとえば、インポートが解決できなかったソースノードの識別子)。診断が特定のソース要素を参照しない場合は存在しません。 |
location | Location | いいえ | 発行元が問題の位置を特定できる場合に、診断が指す位置です。パーサーはバイトスパンを設定し、レンダラーはソースドキュメント内の構造化された位置を設定します。診断に位置がない場合は存在しません。 |
suggest | string | いいえ | 発行元が診断とともに提示する任意の修正のヒントです。ヒントが提示されない場合は存在しません。 |
追加のプロパティは許可されません。
Location
診断が指す位置です。生のソーステキスト内のバイト単位で正確な位置(パーサーがスパンを設定)と、ソースドキュメント内の構造化された位置(レンダラーが key_path、uri、line、kind を設定)の両方に対応する 1 つの統一されたロケーターを持ち、該当するものがある場合は診断が対象とするビルドのインスタンスを示します(instance)。すべてのフィールドは任意です。ソケットは生成できる表現を設定し、残りを省略します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
span | Span | いいえ | 発行元がソースを解析し、問題をバイト範囲に特定できる場合(パーサー)に、診断が指す生のソースバイトのスパンです。それ以外の場合は存在しません。 |
key_path | string | いいえ | 発行元が問題を構造的に特定する場合(レンダラー)に、構造化されたソースドキュメント内の問題のある要素へのドット区切りのパスです。それ以外の場合は存在しません。 |
uri | string | いいえ | 発行元が把握している場合(レンダラー)に、診断が対象とするソースアーティファクトの識別子です。それ以外の場合は存在しません。ビルドのインスタンスを示すことはなく、それは instance が担います。 |
line | integer | いいえ | 構造化されたソースドキュメント内の行番号で、span が持つ生バイトの行および列とは別のものです。発行元がドキュメントの行を把握している場合(レンダラー)に存在します。それ以外の場合は存在しません。 |
kind | string | いいえ | 発行元がサーフェスを区別する場合(レンダラー)に、位置が参照するソースのサーフェスを示す自由形式の文字列です。それ以外の場合は存在しません。 |
instance | string | いいえ | 診断が対象とするビルドのインスタンスで、ビルドがそれに与える識別子で示されます。コンポーネントは Aggregate がそれを宣言している名前で、モジュールが提供するコンポーネントはモジュールを通るドット区切りのパスで、ビルドが導出するコンポーネントはビルドがそれのために合成する識別子で、モジュールはそれ自身のパスで示されます。診断が 1 つのインスタンスに関するものである場合に存在し、それ以外の場合は存在しません。 |
追加のプロパティは許可されません。
Span
元のソースバイトのスパンです。バイトオフセットが主要かつ正確な位置であり、行番号と列番号は人間が読める診断のためにそれに付随します。
| プロパティ | 種類 | 必須 | 説明 |
|---|---|---|---|
start_offset | integer | はい | 元のソースにおけるスパンの最初のバイトのバイトオフセットで、0 始まりです。 |
end_offset | integer | はい | 元のソースにおけるスパンの最後のバイトの 1 つ後のバイトオフセットです。したがって、end_offset から start_offset を引いた値がスパンのバイト長になります。 |
start_line | integer | はい | スパンの開始位置の行番号で、1 始まりです。人間が読める診断に使われます。 |
start_column | integer | はい | スパンの開始位置の列番号で、1 始まりです。人間が読める診断に使われます。 |
end_line | integer | はい | スパンの終了位置の行番号で、1 始まりです。人間が読める診断に使われます。 |
end_column | integer | はい | スパンの終了位置の列番号で、1 始まりです。人間が読める診断に使われます。 |
追加のプロパティは許可されません。