피드로 돌아가기
GeekNewsFrontend
원문 읽기
Show GN: ESLint Markdown: ESLint로 마크다운 파일들을 린팅하세요
ESLint 공식 API 기반 40여 개 규칙의 Markdown 통합 린팅 체계 구축
AI 요약
Context
Markdown 문서 품질 관리를 위해 markdownlint 등 개별 도구를 사용함에 따른 설정 파편화 발생. ESLint의 공식 Markdown 지원 발표 이후 단일 툴체인 내 통합 관리 필요성 증대.
Technical Solution
- @eslint/markdown 공식 API와 방향성을 준수한 플러그인 설계
- 코어 패키지와 중복되지 않는 20여 개의 고유 규칙 정의를 통한 기능 확장
- CommonMark, GFM, Front Matter 지원을 통한 마크다운 표준 호환성 확보
- recommended, stylistic, base 등 단계별 공유 설정을 통한 설정 비용 최소화
- ESLint 설정 흐름 내 Markdown 통합으로 문서와 코드의 품질 관리 일원화
- 기존 remark-lint 등을 보완하거나 대체 가능한 유연한 확장 구조 설계
실천 포인트
- 기존 ESLint 사용 프로젝트의 Markdown 린팅 통합 비용 검토 - GFM 및 Front Matter 사용 여부에 따른 플러그인 설정 적용 - 코어 규칙과 eslint-markdown의 중복 규칙 제거를 통한 린팅 최적화 - stylistic 설정을 통한 팀 내 문서 작성 컨벤션 통일