vale-cli/vale

어떤 프로젝트인가요?

핵심 기능

• 01검사 전에 Markdown, AsciiDoc, reStructuredText, HTML 및 기타 마크업 형식을 파싱합니다.
• 02검사를 위해 소스 코드에서 주석과 docstring을 추출합니다.
• 03토큰 치환부터 품사 및 가독성 검사까지 YAML로 규칙을 작성합니다.
• 04Microsoft, Google 등의 공개 스타일 패키지를 제공하며 명령 하나로 동기화할 수 있습니다.
• 05규칙에 편집기와 에이전트가 적용할 자동 수정 기능을 포함할 수 있습니다.
• 06단일 Go 바이너리로 macOS, Windows, Linux에서 오프라인으로 실행됩니다.

활용 사례

• 기술 문서 전반에 회사 또는 프로젝트의 스타일 가이드를 적용합니다.
• 문서에 쓰인 제품명과 같은 용어의 불일치를 찾아냅니다.
• CI에서 문장 검사를 실행해 문서 pull request를 자동으로 검증합니다.
• 코드와 함께 해당 코드의 docstring 및 주석을 검사합니다.

빠른 시작

1. 1

   macOS에 Homebrew로 Vale 설치하기

   brew install vale
2. 2

   프로젝트 루트에 .vale.ini 구성 파일 만들기

3. 3

   설정된 스타일 다운로드하기

   vale sync
4. 4

   README.md와 같은 파일 린트하기

   vale README.md

사용 전 알아둘 점

• !일부 플랫폼에는 Go를 이용한 설치 방법만 안내되어 있으며, 다른 방법으로 설치하려면 시스템에서 사용할 수 있는 패키지 관리자가 필요합니다.
• !Vale은 주로 한 명의 메인테이너가 개발하므로 지원과 개발 속도는 한 사람에게 달려 있습니다.

토픽

자주 묻는 질문

vale은(는) 무엇인가요?

오프라인에서 실행되며 편집기, CI, 코드에서 팀의 글쓰기 스타일 규칙을 적용하는 CLI 문장 검사 도구입니다. Vale는 글쓰기 가이드라인을 자동화된 검사 규칙으로 바꿔 주는 문장 검사 도구입니다. 자체적인 스타일을 강요하지 않으므로, 팀은 Microsoft나 Google 같은 공개 스타일 가이드를 선택하거나 자체 용어를 추가하거나 둘을 조합해 Markdown, AsciiDoc, reStructuredText, HTML 등의 문서 형식에 적용할 수 있습니다.

vale은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

vale은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

vale은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. vale의 마지막 커밋은 2026년 10월 16일입니다.

vale은(는) 어디에 사용할 수 있나요?

기술 문서 전반에 회사 또는 프로젝트의 스타일 가이드를 적용합니다. 문서에 쓰인 제품명과 같은 용어의 불일치를 찾아냅니다. CI에서 문장 검사를 실행해 문서 pull request를 자동으로 검증합니다. 코드와 함께 해당 코드의 docstring 및 주석을 검사합니다.

vale는 어떻게 설치하나요?

macOS에 Homebrew로 Vale 설치하기: brew install vale 프로젝트 루트에 .vale.ini 구성 파일 만들기 설정된 스타일 다운로드하기: vale sync README.md와 같은 파일 린트하기: vale README.md

vale은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/vale-cli/vale