ハカセノオト

moon indicating dark mode
sun indicating light mode

vscode で textlint を使って日本語の校正を行う

January 15, 2022

VS Code で日本語の校正するための設定方法を記載する。

利用するツールは、 textlint の vscode 拡張機能 と、日本語向けの rule である textlint-rule-preset-japanese である。

system global な設定として追加することを目指す。

npm install --global textlint # textlint のインストール
npm install --global textlint-rule-preset-japanese # 日本語校正ルールのインストール
npm install --global textlint-rule-preset-ja-technical-writing # 技術文書むけの日本語校正ルールのインストール

下記のようにホームディレクトリに、 .textlintrc ファイルを作成して、設定を書き込む。

$ cat ~/.textlintrc
{
"rules": {
"preset-japanese": true,
"preset-ja-technical-writing": true
}
}

vscode に下記の extension を install する。

https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlint

拡張機能のインストール後、vscode を再起動する。

日本語文書を開いた時に、赤い波線が表示される。 マウスホバーで textlint の指摘内容を確認する。

参考


hnishi のブログ


技術系の記事など。
綺麗に書こうとすると続かない気がするので、割と雑に、備忘録的に書いていく方針。
内容に誤りがあった場合などのご連絡は、Twitter の DM などで頂けると幸いです。
※ 記事中の Amazon 商品ページへのリンクは Amazon アソシエイト・プログラムによるリンクを使用しています。