REF-006 图片引用

概述

验证 Markdown 中的图片引用(形如 ![alt](./img.png))指向实际存在的文件。引用目标不存在时,会报告为 error。

与 Markdown 链接一样,图片文件因移动、重命名、删除而损坏的情况非常常见。与链接断裂不同,图片不显示在视觉上较易察觉,但 CI 不会报错,评审中也常被忽略。本规则可机械化验证图片引用。

字段	类型	必填	说明
`exclude`	string[]	—	从验证中排除的路径 glob 数组

省略全部选项也可工作。exclude 用于排除像由外部 CDN 提供的图片那样仓库中不存在但有意引用的图片(绝对 URL 不在验证范围内,因此仅在以相对路径指定时使用)。

![架构图](./images/architecture.png)

./images/architecture.png 不存在时,判定为违例。

docs/overview.md
  line 1  error  Image target "./images/architecture.png" does not exist  REF-006

![架构图](./images/architecture.png)

将图片文件放置到正确的位置,或将引用路径修正为正确的位置。

{
  "rule": "ref006",
  "options": {
    "exclude": ["generated/**/*.png"]
  }
}