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 끊어진 링크 — 존재해야 하는 파일에 대한 링크가 올바른지의 검증