コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

Aggrega Wasm Linter Socket スキーマ

自動生成されたリファレンスです。手動で編集しないでください。公開されている JSON Schema から再生成してください。

スキーマ ID: https://aggrega.ai/schemas/wasm-linter-v1beta1.schema.json

リンターソケットが受け取る(LinterInput)および出力する(LinterOutput)ワイヤ形式です。リンターは、公開時には旧バージョンと提案バージョンのエンティティの組(スキーマ進化ルール)に対して実行され、ワークスペースのリント時には個々のエンティティ(ルールごとの構造ルール)に対して実行されます。出荷される 1 つの Wasm プラグインが多数のルールをホストし、プラグインは LinterInput.rule_id によって実行するルールを選択します。このスキーマは両方のワイヤ形式の唯一のソースです。Go、Rust、TypeScript のペイロード型はこのスキーマから共有のプラグイン ABI パッケージに生成され、各プラグインキットは独自のコピーを宣言するのではなく、生成されたそれらの型を再エクスポートします。

次のいずれかの形

  • LinterInput
  • LinterOutput

定義

LinterInput

ホストが呼び出しのたびに publishing-linter プラグインへ渡すペイロードです。rule_id は、プラグインがどのルールにディスパッチするかを選択します。entity_kind は、lint 対象のエンティティ種別(Component、Feature、Recipe、FeatureRecipe、SchemaLibrary、MappingLibrary、Aggregate)を示します。proposed は、分類対象のエンティティを解析した構造を保持します(ホストは送信前に YAML を JSON に解析するため、プラグインが生のバイト列を見ることはありません)。previous は、schema-evolution ルールのために、解析済みの前バージョンのエンティティを保持します。該当しない場合は省略されます。implemented_component は、異なる種別の関連エンティティ(lint 対象の Recipe が実現する Component)を保持し、あるエンティティを別のエンティティが宣言する契約と比較するルールで使われます。該当しない場合は省略されます。release と components は、Release 全体を読むルールのために Release の残りの部分を保持します。このとき proposed はその Release がデプロイする Aggregate、release はその Release、components は Aggregate の各コンポーネントインスタンスがインスタンスとなっている Component です。これ以外のすべての入力では両方とも省略されます。policies は、ルールが参照するワークスペースごとの公開規律の設定を保持します。

プロパティ種類必須説明
rule_idstringはいプラグインがディスパッチすべきルールで、ルール ID で指定します。これは結果の finding が rule_id に保持するものと同じケバブケースの識別子であり、抑制されたルールや報告されたルールはどの場面でも同じ名前で示されます。認識されるセットは出荷されたプラグインがディスパッチするものすべてです。プラグインが認識しないルール ID は、黙って通過するのではなく、‘unknown_rule’ finding を生成します。
entity_kindstring (enum)はいproposed/previous の値がエンコードするエンティティ種別です。schema-evolution ルールの分類は種別ごとに異なり、構造的なルールは特定の種別を対象とします。許可される値:"Component"、"Feature"、"Recipe"、"FeatureRecipe"、"SchemaLibrary"、"MappingLibrary"、"Aggregate"
proposedobjectはい分類対象のエンティティを解析した構造です。ホストは送信前に YAML を JSON に変換するため、プラグインは構造化済みの値を受け取り、生のバイト列を見ることはありません。Release 全体を読むルールの入力では、その Release がデプロイする Aggregate になります。すべての入力で、エンティティが渡される前にすべてのパラメーター値が削除されます。パラメーターの値は認証情報そのものである場合があるため、このフィールドを通じてパラメーター値が linter プラグインに届くことはありません。Aggregate は spec.parameters の宣言を保持しますが、各宣言には Aggregate スキーマがパラメーター宣言に認める default 以外のキーだけが残り、properties、items、valuesType の下にネストされたすべての宣言にも同じことが適用されます。default は置き換えられるのではなく削除されるため、プラグインは宣言が default を与えているかどうかを判別できません。また、スキーマがその位置に認めないキーは、その内容ごと削除されます。spec.aggregates の下にある各モジュールの parameters ブロックは、そのモジュールに渡される値を保持するため、丸ごと削除されます。他の種別のエンティティの spec.parameters も同様です。パラメーターを読むテンプレートテキストは記述どおりに保持されます。
previousobjectいいえペアワイズ比較を行うルール(schema-evolution)のための、前バージョンのエンティティを解析した構造です。パラメーター値は proposed から削除されるのとまったく同じように削除されます。ルールが前バージョンの参照を必要としない場合(例:初回公開、構造のみのルール)は省略されます。
implemented_componentobjectいいえlint 対象の Recipe が spec.implements で指定する Component を解析した構造で、ホストが解決します。これは lint 対象とは異なる種別の関連エンティティであり、この点で previous と区別されます。previous は同じエンティティの別バージョンを保持するのに対し、こちらは Recipe が実現する出力契約を宣言する Component を保持します。ホストはビルドと同じカタログ検索を使い、Component の名前をキーとして解決するため、spec.implements が受け付ける 3 つのピン形式(バージョンなし、完全一致、メジャー互換範囲)はすべて同じエントリーに到達します。lint 対象のエンティティが Recipe でない場合、Component を指定していない場合、またはその名前の Component がワークスペースのカタログディレクトリで到達できない場合は省略されます。値がないことは、比較が利用できないことを意味し、契約が空であることを意味しません。このフィールドを読むルールは、値がない場合には finding を出力しません。
releaseobjectいいえrelease スコープの lint が指定する Release を解析した構造で、extends チェーンが折り込まれているため、子 Release はベースから継承したものを保持します。ホストは proposed と同様に YAML から JSON に変換します。その spec.parameters ブロックは Aggregate のパラメーターを満たす値を保持するため、Release が渡される前に丸ごと削除されます。パラメーターの値は認証情報そのものである場合があり、このブロックを読むルールはないため、このフィールドを通じてパラメーター値が linter プラグインに届くことはありません。Release 全体を読むルールの入力にのみ存在し、そのとき proposed はこの Release がデプロイする Aggregate で、そのパラメーター値は proposed の説明どおりに削除されています。これ以外のすべての入力では省略されます。
componentsobject のマップいいえAggregate の各コンポーネントインスタンスがインスタンスとなっている Component で、Aggregate がそのインスタンスに与えるインスタンス名をキーとします。このキーは、Aggregate と Release 自身の components マップが使うものと同じです。各値はインスタンスの型が解決される Component で、extends チェーンがあれば折り込まれ、implemented_component と同様に JSON に変換されます。Component がワークスペースのカタログディレクトリで到達できないインスタンスは存在せず、ルールはその不在を、何も宣言しない Component としてではなく、利用できないものとして扱います。release と並んで、Release 全体を読むルールの入力にのみ存在します。これ以外のすべての入力では省略されます。
source_pathstringいいえエンティティが読み込まれたファイルシステムパスです。カタログのファイルシステムを走査するホスト側の呼び出し元が設定し、パスを考慮するルール(例:category-matches-directory)が使用します。呼び出し元がパスのコンテキストを持たない場合は省略されます。
policiesPoliciesいいえルールが参照するワークスペースごとの公開規律の設定で、ホストがワークスペース設定とコマンドラインでの上書きから組み立てる Policies オブジェクトとして渡されます。

追加のプロパティは許可されません。

LinterOutput

publishing-linter プラグインが出力するレスポンスの形です。findings は、結果を生成したルール呼び出しごとに 1 つのエントリーを保持します。schema-evolution ルールは finding をちょうど 1 つ(分類の判定)出力します。構造的なルールは 0 個(違反なし)または複数(違反ごとに 1 つ)を出力することがあります。

プロパティ種類必須説明
findingsDiagnostic[]はいプラグイン呼び出しによって生成されたルールごとの finding で、プラグインが出力した順に並びます。
errorstringいいえゲストは実行されたものの操作を完了できなかった場合に設定される失敗メッセージです。成功時には存在しません。出力に含まれる診断とは別のものです。診断は結果を生成した実行中に見つかった問題を報告し、error は操作自体が完了しなかったことを報告します。ホストは error が存在する場合、プラグイン呼び出しの失敗として扱います。

追加のプロパティは許可されません。

Policies

ルールセットが参照するワークスペースごとの公開規律の設定です。ホストがワークスペース設定の公開規律の設定とコマンドラインでの上書きから組み立てます。このスキーマがこの形の契約です。フィールドを省略すると各フラグは false になり、ホストは値がデフォルトでないフィールドのみを書き込みます。

プロパティ種類必須説明
allow_dynamic_refs真偽値いいえtrue の場合、SchemaLibrary エントリでの $dynamicAnchor / $dynamicRef の使用が許可されます(dynamic-refs ルールを抑制します)。デフォルトは false です。
allow_id_overrides真偽値いいえtrue の場合、SchemaLibrary エントリでの $id の上書きが許可されます(id-overrides ルールを抑制します)。デフォルトは false です。
allow_direct_x_aggrega_extensions真偽値いいえtrue の場合、x-aggrega-selector / x-aggrega-inject を直接記述することが許可されます(x-aggrega-discouragement ルールを抑制します)。デフォルトは false です。
allow_aggrega_ai_prefix真偽値いいえtrue の場合、annotation-prefix ルールが完全に抑制されます(素の aggrega.ai/ のチェックと、種類に応じた feature.aggrega.ai/ のチェックの両方)。デフォルトは false です。
allow_nonstandard_names真偽値いいえtrue の場合、name-shape 違反が許可されます(name-shape ルールを抑制します)。デフォルトは false です。
allow_category_mismatches真偽値いいえtrue の場合、category-matches-directory ルールの検出結果を抑制します。標準カタログの慣例では、core// 配下の Components は、ディレクトリのセグメントに一致する component.aggrega.ai/category={category} を宣言することが求められます。ここで {category} は 15 個の閉じた集合の値のいずれかです。正当な恒常的例外を持つワークスペースは、ここでオプトアウトします。デフォルトは false です。
allow_undeclared_recipe_provides真偽値いいえtrue の場合、provides-declared-by-component ルールの検出結果を抑制します。このルールは、Recipe が spec.provides で公開するキーのうち、その spec.implements が指定する Component が spec.schema の provides の柱で宣言していないものをそれぞれ報告します。宣言された契約を超えた公開はビルド時に受け入れられるため、この検出結果は助言的なものです。Recipes が Component の宣言していないキーを意図的に公開するワークスペースは、ここでオプトアウトします。デフォルトは false です。
allow_connection_credential_mismatches真偽値いいえtrue の場合、connection-credential-matches-target-key ルールの検出結果を抑制します。このルールは Release 全体を読み取り、呼び出し元に要求するキーをターゲットが宣言している各接続について、接続が提示する資格情報とターゲットが保持するキーを比較します。両端が異なるシークレットを指定している場合と、キーが一方の端でのみ宣言されている場合を報告します。両端の一致はビルドがチェックするものではなくカタログの慣例であるため、この検出結果は助言的なものです。両端が意図的に異なるワークスペースは、ここでオプトアウトします。デフォルトは false です。

追加のプロパティは許可されません。