Show GN: ESLint Markdown: ESLint로 마크다운 파일들을 린팅하세요
(github.com/lumirlumir)ESLint로 마크다운 파일을 린팅할 수 있는 eslint-markdown 패키지를 발행했습니다.
2024년 10월 3일 ESLint가 마크다운 지원을 공식 발표한 이후, 공식 API와 방향성에 맞춰 설계한 플러그인입니다.
이 프로젝트는 커뮤니티 기반으로 개발되고 있으며, ESLint 코어의 언어 플러그인 개발 경험을 바탕으로 안정성, 호환성, 지속적인 유지보수를 우선해 만들었습니다.
eslint-markdown은 ESLint 코어의 Markdown 지원 패키지인 @eslint/markdown과 겹치지 않는 20여 개의 규칙을 제공합니다. 코어 규칙과 함께 사용하면 40개 이상의 마크다운 관련 규칙을 활용할 수 있습니다. 또한 CommonMark, GitHub Flavored Markdown(GFM), Front Matter를 지원하며, recommended, stylistic, base 같은 공유 설정도 함께 제공합니다.
이미 ESLint를 사용하고 있는 프로젝트라면, 비교적 적은 비용으로 마크다운 린팅까지 같은 설정 흐름 안에 자연스럽게 통합할 수 있습니다. 문서와 코드의 품질 관리를 한 곳에서 함께 가져가고 싶은 팀이나 프로젝트에 특히 잘 맞습니다.
장기적으로는 ESLint 하나로 다양한 파일을 함께 린팅할 수 있는 흐름을 만들고, 기존 마크다운 린팅 도구인 markdownlint나 remark-lint를 보완하거나 일부 경우에는 대체할 수 있는 선택지로 발전시키는 것을 목표로 하고 있습니다.
앞으로 스타일 규칙을 포함해 더 다양한 규칙들을 추가해나갈 예정입니다. 마크다운도 JavaScript/TypeScript처럼, 같은 ESLint 설정 흐름 안에서 일관되게 관리할 수 있도록 계속 다듬어가겠습니다.
피드백과 기여는 언제나 환영합니다.