콘텐츠로 이동
contextlint

REF-001 끊어진 링크

개요

섹션 제목: “개요”

Markdown 내의 상대 링크([text](./file.md) 형식)가 실재하는 파일을 가리키고 있는지를 검증합니다. 링크 대상이 존재하지 않는 경우는 error 가 됩니다. 앵커 프래그먼트(#section)는 링크 대상 파일 판정에서 제외되며, 그 타당성은 REF-005 앵커의 책임입니다.

왜 필요한가

섹션 제목: “왜 필요한가”

파일 이름 변경·삭제·이동으로 링크가 끊어지는 것은, Markdown을 운용하면서 가장 자주 발생하는 열화입니다. AI 생성에서는 존재하지 않는 파일에 대한 링크가 섞이는 경우도 있습니다. 끊어진 링크가 있어도 markdownlint도 CI도 통과해 버리기 때문에 기계적인 검출이 필요합니다.

옵션

섹션 제목: “옵션”
필드타입필수설명
excludestring[]—링크 대상의 검증에서 제외할 경로의 glob 배열

옵션 전체를 생략해도 동작합니다. exclude는 외부 문서나 생성물처럼 include의 대상 외이지만 의도적으로 존재하지 않는 파일을 참조하는 경우에 사용합니다.

위반 예시

섹션 제목: “위반 예시”
자세한 내용은 [아키텍처](./architecture.md)를 참조하세요.

./architecture.md가 존재하지 않는 경우, 위반이 됩니다.

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

수정 후

섹션 제목: “수정 후”
자세한 내용은 [아키텍처](./architecture.md)를 참조하세요.

링크 대상 파일 architecture.md를 작성하거나, 링크를 올바른 경로로 수정합니다.

설정 예시

섹션 제목: “설정 예시”
{
  "rule": "ref001",
  "options": {
    "exclude": ["generated/**/*.md"]
  }
}

관련 규칙

섹션 제목: “관련 규칙”