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"]
  }
}

関連ルール

• SEC-001 必須セクション — ファイル存在の次の段階として、各ドキュメント内の見出し構造を検証
• REF-001 リンク切れ — 存在するはずのファイルへのリンクが正しいかの検証