콘텐츠로 이동

SEC-001 필수 섹션

문서에 필수 섹션 제목이 존재하는지를 검증합니다. sections로 지정한 제목 중 어느 하나라도 존재하지 않으면 error 가 됩니다.

ADR, 요구사항서, 설계서 등 같은 템플릿으로 작성되어야 할 문서라도, 작성자에 따라 ## 배경이나 ## 결정 사항이 누락되는 경우가 있습니다. AI 생성이나 급히 추가 작성한 경우에 특히 발생하기 쉽고, 리뷰에서도 놓치기 쉽습니다. 이 규칙이 제목의 누락을 기계적으로 검출합니다.

필드타입필수설명
sectionsstring[]필수로 둘 섹션 제목 텍스트의 배열
filesstring이 규칙을 적용할 파일의 glob
# ADR-001 인증 방식 선정
## 배경
인증 방식을 선정할 필요가 있다.
## 결정 사항
JWT를 채택한다.

sections: ["배경", "결정 사항", "영향"]을 설정한 경우, 영향 섹션이 없기 때문에 위반이 됩니다.

docs/adr/001.md
line 0 error Missing required section "영향" SEC-001
# ADR-001 인증 방식 선정
## 배경
인증 방식을 선정할 필요가 있다.
## 결정 사항
JWT를 채택한다.
## 영향
세션 스토어가 불필요해진다.
{
"rule": "sec001",
"options": {
"sections": ["배경", "결정 사항", "영향"],
"files": "adr/*.md"
}
}

files를 지정하면, ADR이나 요구사항서처럼 특정 디렉터리의 문서에만 템플릿을 강제할 수 있습니다.