Valeによる文章チェック

Valeは、設定可能なスタイルルールに照らしてドキュメントをチェックするコマンドラインの文章リンターです。MarkdownおよびMDXファイルとの統合性が高く、docStaticプロジェクトに自然に適合します。

Valeのインストール

お使いのプラットフォームへのインストール手順については、Valeインストールガイドを参照してください。ValeはHomebrew、apt、Chocolatey、および直接バイナリダウンロードで利用可能です。

macOS

brew install vale

Linux

# Debian / Ubuntu
sudo apt install vale

Windows

choco install vale

プロジェクト設定

docStaticプロジェクトには、リポジトリのルートに .vale.ini が含まれています。主な設定は次のとおりです。

設定	値	目的
StylesPath	.vale/styles	ダウンロード済みおよびカスタムスタイルパッケージのディレクトリ
MinAlertLevel	suggestion	すべての結果を表示（suggestion、warning、error）
[formats]	mdx = md	.mdx ファイルをMarkdownとして処理

スタイルの同期

リポジトリのクローン後、vale sync を一度実行して .vale.ini に記載されたスタイルパッケージをダウンロードします。

vale sync

これにより .vale/styles/ に設定済みパッケージが展開されます。ダウンロードしたパッケージがコミットされないよう、.vale/styles/ を .gitignore に追加してください。

ドキュメントのリント

docs/ ディレクトリに対してValeを実行します。

vale docs/

または単一ファイルをリントします。

vale docs/guides/my-page.mdx

Valeはファイルごとにグループ化された結果を出力し、行番号、アラートレベル、トリガーされたルールを表示します。

スタイルパッケージの追加

Valeにはコミュニティスタイルパッケージのライブラリがあります（Google、Microsoft、write-goodなど）。追加するには、.vale.ini の BasedOnStyles で参照します。

[*.{md,mdx}]
BasedOnStyles = Vale, Google

その後、vale sync を再度実行してダウンロードします。

カスタムルール

プロジェクト固有のルールを .vale/styles/ 内のYAMLファイルとして追加できます。ルールの形式についてはValeドキュメントを参照してください。

エディター統合

Valeには、VS Code（Vale VSCode）やその他のエディター向けの拡張機能があり、作業中にインラインで結果を表示します。