REF-006 画像参照
Markdown 内の画像参照( の形式)が、実在するファイルを指していることを検証します。参照先が存在しない場合は error で報告されます。
画像ファイルの移動・リネーム・削除でリンクが壊れるのは、Markdown リンクと同じくよくある劣化です。リンク切れと違って、画像が表示されないと見た目で気づきやすい一方、CI ではエラーにならず、レビューでも見落とされることがあります。このルールは画像参照を機械的に検証します。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
exclude | string[] | — | 検証から除外するパスの glob 配列 |
オプション全体を省略しても動作します。exclude は外部 CDN で配信される画像のように、リポジトリには存在しないが意図的に参照したい画像を除外する場合に使います(絶対 URL は対象外なので、相対パスで指定する場合に限ります)。
./images/architecture.png が存在しない場合、違反になります。
docs/overview.md line 1 error Image target "./images/architecture.png" does not exist REF-006画像ファイルを正しい場所に配置するか、参照パスを正しい場所に修正します。
{ "rule": "ref006", "options": { "exclude": ["generated/**/*.png"] }}- REF-001 リンク切れ — 画像ではなくリンクの参照先存在の検証
- REF-005 アンカー — リンク先ファイル内のアンカーの検証
- STR-001 ファイル存在 — プロジェクトレベルでの必須ファイル存在の検証