STR-001 文件存在

概述

验证项目中存在必需的文件。files 中指定的任何路径缺失时,会报告为 error。这是项目作用域规则,会跨越 include 加载的所有文档进行评估。

像 README.md、CONTRIBUTING.md、docs/architecture.md 这类作为仓库起点的文档,通常被其它文档以「存在」为前提引用。一旦因重命名或删除而丢失这些起点文件,影响的不仅是链接断裂,更会导致整个文档结构崩塌。本规则可检测起点的缺失。

字段	类型	必填	说明
`files`	string[]	✓	必须存在的文件路径数组

files 中的每个元素会与 include 加载的文件列表进行完全匹配,请使用从项目根目录开始的相对路径。

设置 files: ["README.md", "docs/architecture.md"] 但 docs/architecture.md 不存在时,会判定为违例。

project
  line 0  error  Required file "docs/architecture.md" not found  STR-001

创建 docs/architecture.md 即可消除违例。

{
  "rule": "str001",
  "options": {
    "files": ["README.md", "docs/architecture.md", "CONTRIBUTING.md"]
  }
}