診断（Diagnostics）

診断はCoreとプラグインが出力する構造化された検出結果で、何が問題か、どこで起きるか、どれくらい重要か、どう直すかを示します。プラグインはaddDiagnosticsで診断を報告し、Coreがcheckとdoctorコマンド用にまとめます。

診断の構造

診断は、何が問題か（what）、どこで起きるか（where）、どれくらい重要か（severity）、どう直すか（how to fix）を表します。設定とプラグインの妥当性にはcheck、より広い健全性にはdoctorを使います。

報告

addDiagnostics(context) {
  return [
    {
      id: "duplicate-content-id",
      severity: "error",
      message: "Multiple articles share the same content ID",
    },
  ];
}

診断のフィールド

• id：安定した診断コード（Diagnostic code参照）
• severity：error、warn、infoのいずれか
• message：問題を人間が読める形で説明したもの
• cause：診断の原因となった元のエラー（任意）

関連用語

• Diagnostic code
• Plugin
• Inspector
• Build

さらに詳しく

• Diagnostics