콘텐츠로 이동
contextlint

REF-006 이미지 참조

개요

섹션 제목: “개요”

Markdown 내의 이미지 참조(![alt](./img.png) 형식)가 실재하는 파일을 가리키고 있는지를 검증합니다. 참조 대상이 존재하지 않는 경우는 error 로 보고됩니다.

왜 필요한가

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

이미지 파일의 이동·이름 변경·삭제로 링크가 끊어지는 것은, Markdown 링크와 마찬가지로 자주 있는 열화입니다. 끊어진 링크와 달리 이미지가 표시되지 않으면 외관으로 알아채기 쉬운 한편, CI에서는 에러가 되지 않고 리뷰에서도 놓치는 경우가 있습니다. 이 규칙은 이미지 참조를 기계적으로 검증합니다.

옵션

섹션 제목: “옵션”
필드타입필수설명
excludestring[]—검증에서 제외할 경로의 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"]
  }
}

관련 규칙

섹션 제목: “관련 규칙”