콘텐츠로 이동

TBL-001 필수 컬럼

테이블의 헤더 행에 필수 컬럼이 모두 포함되어 있는지를 검증합니다. requiredColumns로 지정한 컬럼명 중 어느 하나라도 존재하지 않으면 error 가 됩니다.

요구사항 테이블, API 사양, 데이터 정의 등에서 특정 컬럼(ID, Status, Owner 등)이 반드시 존재하는 것을 팀에서 합의해도, 새 테이블을 작성할 때 컬럼을 통째로 잊어버리거나, 테이블 구조의 일부만 수정하고 다른 부분을 잊어버리는 실수가 발생합니다. 이 규칙이 그것을 방지합니다.

필드타입필수설명
requiredColumnsstring[]필수로 둘 컬럼명의 배열
sectionstring검증 대상을 특정 섹션 하위의 테이블로만 한정 (제목에 포함되는 문자열)
filesstring이 규칙을 적용할 파일의 glob
## 요구사항
| ID | 내용 |
| ------ | ---------------- |
| REQ-01 | 사용자 등록 |

requiredColumns: ["ID", "Status"]를 설정한 경우, Status 컬럼이 없기 때문에 위반이 됩니다.

docs/requirements.md
line 3 error Missing required column "Status" in table TBL-001
## 요구사항
| ID | 내용 | Status |
| ------ | ---------------- | ------ |
| REQ-01 | 사용자 등록 | stable |
{
"rule": "tbl001",
"options": {
"requiredColumns": ["ID", "Status"],
"section": "요구사항",
"files": "specs/*.md"
}
}
  • TBL-002 빈 셀 — 필수 컬럼이 존재하는 전제 위에서 셀이 비어 있지 않은지를 검증
  • TBL-003 허용 값 — 컬럼 값이 허용 리스트에 포함되는지를 검증