カスタム日本語校正

textlintを用いて、VS Code上でテキストファイル（Markdown、HTML、LaTeX、Re:VIEW含む）の日本語の文章を自動校正する拡張機能です。

all-rules.mdにあるようなすぐに使えるプリセットルールが簡単に使えます。textlintをインストールする必要はありませんし、それによってnpm環境を汚すこともありません。

さらに、正規表現が使えるprhパッケージや、形態素解析の結果が使えるtextlint-rule-morpheme-matchパッケージをサポートしており、柔軟な校正ルールの設定が可能です。

使い方

拡張機能のインストール後、テキストファイルを開くと自動で文章のチェックが行われます。

対応しているテキストファイルは以下の形式です。

• テキストファイル（.txt）
• Markdownファイル（.md）
• HTMLファイル（.html）
• Latexファイル（.tex）
• Re:VIEWファイル（.re）

設定

settings.jsonは次のような見た目になります。

// .vscode/settings.json
{
    "customJapaneseProofreading.textlintrcPaths": [
        "./.vscode/.textlintrc.json",
        // ":default:"
    ],
    "customJapaneseProofreading.checkOn": "save",
    "customJapaneseProofreading.maxNumberOfProblems": 100,
}

checkOn

校正を行うタイミングを指定します。

• "save": ファイルを保存するたびに校正を行います。
• "change": ファイルを変更するたびに校正を行います。

maxNumberOfProblems

表示する問題の最大数を指定します。デフォルトは100です。

textlintrcPaths

校正に使用するtextlintrcファイルへのパスを指定します。 複数のパスを指定できます。

特殊な値があります。

• "./"は、ワークスペースのルートディレクトリを指します。
• ":default:"は、デフォルトの設定ファイルを指します。これは、テキスト校正くんのデフォルト設定ファイルになっていると思います。

textlintrc ファイル

設定ファイルの書き方は、textlint/.textlintrcを参照してください。 ただし、textlintrcは本来色々な形式で書くことができますが、この拡張機能ではJSON形式で書き、拡張子もファイル名に含めることを推奨します。

サポートしているルールの一覧は、 all-rules.md を参照してください。

謝辞

この拡張機能は、テキスト校正くんのv0.1.6をベースにしています。 テキスト校正くんの開発者の方々に感謝を申し上げます。