コンテンツにスキップ
contextlint

REF-001 リンク切れ

概要

Section titled “概要”

Markdown 内の相対リンク（[text](./file.md) の形式）が、実在するファイルを指していることを検証します。リンク先が存在しない場合は error になります。アンカーフラグメント（#section）はリンク先ファイル判定からは除外され、その妥当性は REF-005 アンカー の責務です。

なぜ必要か

Section titled “なぜ必要か”

ファイルのリネーム・削除・移動でリンクが壊れるのは、Markdown を運用するうえで最も頻繁に起きる劣化です。AI 生成では存在しないファイルへのリンクが混入することもあります。リンク切れがあっても markdownlint も CI もパスしてしまうため、機械的な検出が必要です。

オプション

Section titled “オプション”
フィールド型必須説明
excludestring[]—リンク先の検証から除外するパスの glob 配列

オプション全体を省略しても動作します。exclude は外部のドキュメントや生成物のように、include の対象外だが意図的に存在しないファイルを参照する場合に使います。

違反例

Section titled “違反例”
詳細は [アーキテクチャ](./architecture.md) を参照してください。

./architecture.md が存在しない場合、違反になります。

docs/overview.md
  line 1  error  Link target "./architecture.md" does not exist  REF-001

修正後

Section titled “修正後”
詳細は [アーキテクチャ](./architecture.md) を参照してください。

リンク先ファイル architecture.md を作成するか、リンクを正しいパスに修正します。

設定例

Section titled “設定例”
{
  "rule": "ref001",
  "options": {
    "exclude": ["generated/**/*.md"]
  }
}

関連ルール

Section titled “関連ルール”