위키득계정 ↗
기술

Vale 문서 검사기

Vale 문서 검사기기술
검사 대상
문서의 자연어 표현
규칙 형식
YAML
구현 언어
Go
실행 방식
로컬 검사
Vale는 글의 용어와 표현을 정해진 작성 규칙에 맞춰 검사하는 명령행 도구다. 마크업 구조를 이해하며 팀의 문체 지침을 편집기와 CI에서 실행할 수 있는 규칙으로 다룬다.

문체 지침을 규칙으로

같은 대상을 서로 다른 이름으로 부르거나 금지한 표현을 반복하면 문서의 일관성이 떨어진다. Vale는 조직의 용어와 작성 지침을 검사 규칙으로 표현하는 틀을 제공한다. 자체 문체를 일괄 강요하기보다 적용할 스타일을 설정하고 그 기준에 맞는 진단을 얻는 방식이다.

문서 구조를 고려한 검사

Markdown과 HTML, AsciiDoc 등 문서 형식을 파싱해 본문과 구조를 구분한다. 제목이나 표의 셀 같은 범위에 규칙을 적용할 수 있으며 코드와 URL처럼 일반 문장으로 검사하면 안 되는 영역을 구별한다. 따라서 파일 전체를 단순 문자열로 검색하는 방식과 차이가 있다.

팀의 작성 과정에 통합

스타일은 YAML 규칙 파일을 모아 구성하고 설정 파일에서 적용 대상을 정한다. 공개된 스타일을 가져오거나 조직의 규칙을 만들어 사용할 수 있다. 검사는 로컬에서 수행하며 편집기나 CI에 연결할 수 있다. 진단은 설정한 작성 기준에 대한 결과이므로 내용의 사실성을 판정하는 검사와는 구별된다.

관련 문서

Markdownlint / ShellCheck / Semgrep / 마크다운