vale-cli/vale

これは何？

主な機能

• 01Markdown、AsciiDoc、reStructuredText、HTMLなどのマークアップ形式を解析してから文章をチェックします。
• 02ソースコードからコメントやdocstringを抽出してチェックします。
• 03トークンの置換から品詞や可読性のチェックまで、YAMLでルールを記述できます。
• 04MicrosoftやGoogleなどの公開スタイルパッケージが付属し、1つのコマンドで同期できます。
• 05ルールに自動修正を含め、エディターやエージェントから適用できます。
• 06単一のGoバイナリとして、macOS、Windows、Linux上でオフライン動作します。

ユースケース

• 技術文書全体に会社やプロジェクトのスタイルガイドを適用する。
• 文書内の商品名など、用語の不統一を検出する。
• CIで文章をチェックし、ドキュメントのプルリクエストを自動検証する。
• 説明対象のコードと合わせて、docstringやコードコメントをチェックする。

クイックスタート

1. 1

   macOSにHomebrewでValeをインストールする

   brew install vale
2. 2

   プロジェクトのルートに.vale.ini設定ファイルを作成する

3. 3

   設定したスタイルをダウンロードする

   vale sync
4. 4

   README.mdなどのファイルをLintする

   vale README.md

使う前に知っておきたいこと

• !一部のプラットフォームではGoを使ったインストール方法しか記載されていません。それ以外の方法では、システムで利用できるパッケージマネージャーが必要です。
• !Valeの開発は主に1人のメンテナーが担っているため、サポートと開発の速度はその人に左右されます。

収録されている特集

トピック

よくある質問

vale とは？

オフラインで動作し、エディター、CI、コード内でチームの文章スタイル規則を適用できるコマンドラインの文章リンター。 Valeは、文章のガイドラインを自動チェックに変換する文章リンターです。独自のスタイル規則は含まれていないため、MicrosoftやGoogleなどが公開しているスタイルガイドを選び、独自の用語を追加したり、両方を組み合わせたりして、それらの規則をMarkdown、AsciiDoc、reStructuredText、HTMLなどの文書形式に適用できます。

vale は無料で使えますか？ライセンスは？

vale は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

vale は今もメンテナンスされていますか？

活発にメンテナンス中。vale の最終コミットは 2026年10月16日 です。

vale は何に使えますか？

技術文書全体に会社やプロジェクトのスタイルガイドを適用する。 文書内の商品名など、用語の不統一を検出する。 CIで文章をチェックし、ドキュメントのプルリクエストを自動検証する。 説明対象のコードと合わせて、docstringやコードコメントをチェックする。

vale のインストール方法は？

macOSにHomebrewでValeをインストールする: brew install vale プロジェクトのルートに.vale.ini設定ファイルを作成する 設定したスタイルをダウンロードする: vale sync README.mdなどのファイルをLintする: vale README.md

vale はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/vale-cli/vale