피드로 돌아가기
Dev.toDevOps
원문 읽기
YARD의 Brace-based InvalidLink 경고 제거를 위한 전처리 파이프라인 구축
yard-fence 0.9.0: cleaner YARD docs when Markdown braces get in the way
AI 요약
Context
YARD 엔진이 Markdown 내의 중괄호({ })를 Reference Link 문법으로 오인하여 불필요한 InvalidLink Warning을 생성하는 문제 발생. 지속적인 경고 발생으로 인해 실제 빌드 오류를 식별하는 신호 대 잡음비(SNR)가 저하되는 한계점 노출.
Technical Solution
- Rake 기반의 Pre-processing 및 Post-processing 파이프라인 설계
- 원본 소스 훼손 방지를 위해
tmp/yard-fence/경로에 임시 Staging 영역 구축 - ASCII 중괄호를 시각적으로 유사한 Fullwidth 중괄호로 치환하여 YARD의 Link 파싱 우회
- YARD 빌드 완료 후 생성된 HTML 내의 Fullwidth 문자를 다시 표준 ASCII 중괄호로 복구하는 역치환 로직 적용
Yard::Fence.install_rake_tasks!를 통한 전처리-빌드-후처리 단계의 원자적 실행 보장
실천 포인트
1. 외부 라이브러리의 파싱 에러 발생 시 원본 수정 대신 임시 Staging 파일을 활용한 전처리 도입 검토
2. 빌드 파이프라인 내에서 '치환 -> 처리 -> 복구' 순의 idempotent한 워크플로우 설계
3. 불필요한 Warning 누적으로 인한 실제 에러 간과를 방지하기 위해 빌드 로그의 Noise 제거 우선순위 설정