Zero-dependency Regex 스캐너 기반 JSDoc 누락 탐지 CLI 구현

My code reviewer kept asking for JSDoc — so I built a zero-dep CLI that catches it first

benjamin2026년 6월 23일2분beginner

AI 요약

Context

ESLint 등 기존 Linter가 구문 분석에 집중하여 Exported API의 실제 문서화 여부를 검증하지 못하는 한계 직면. PR 리뷰 단계에서 반복되는 JSDoc 요청을 자동화하여 개발 생산성을 저해하는 병목 지점 제거 필요.

Technical Solution

Zero-dependency 설계를 통한 설치 시간 제로화 및 런타임 오버헤드 제거
AST Parser 대신 정규표현식 기반 Line-by-line 스캐닝 방식을 채택한 경량 분석 구조
Export 패턴 탐지 후 역방향 탐색을 통해 직전 JSDoc 블록 존재 여부를 검증하는 로직 설계
JSDoc 내 @param 태그와 실제 함수 파라미터 리스트를 비교 대조하는 검증 프로세스 구축
파이프라인 통합을 위한 표준 Exit Code(0, 1, 2) 및 JSON 출력 옵션 지원

실천 포인트

- API 문서화 강제를 위해 AST 기반의 무거운 도구 대신 정규표현식 기반의 경량 스캐너 검토 - CI/CD 파이프라인 통합을 위해 도구 설계 단계부터 표준 Exit Code 정의 - 내부 헬퍼 함수와 Exported API를 분리하여 문서화 대상 범위를 명확히 정의

태그

#JSDoc #Zero-dependency #Regex #Static Analysis #CLI

원문 읽기