textlintとIntelliJと

1 min read読了の目安(約1100字

textlintで記事を読みやすく

textlintとは、文字校正を全自動で行えるようにしたnodeで動作するnpmパッケージです。

校正は日本語にも対応しており、このZenn記事を書くのにも重宝しています。

以前はVS Codeプラグイン「テキスト校正くん」を使用していました。
ただ、メインとして使用しているIntelliJ系で校正機能を使いたかったので、設定方法をメモがてら残しておきます。

textlintインストール

$ pnpm i textlint textlint-rule-prh textlint-rule-preset-ja-technical-writing textlint-rule-preset-icsmedia

今回導入するルールは、技術関連の文章に特化したものと、ICS Mediaが作成したルールの2つです。

このほかにもいろいろ公開されているので、自分にあったものや自分の業界のものあるかもしれませんので探してみてください。

File Watcher

https://pleiades.io/help/idea/using-file-watchers.html

Intellijのファイル監視機能を使用し、ファイルが保存されたら自動でtextlintが動作するように設定します。

私の設定。

Edit File watcher window

  • File Watcherの詳細設定画面
    • Arguments: -f unix $FileRelativePath$
    • Working directory: $ContentRoot$
    • Output Filters: $FILE_PATH$:$LINE$:$COLUMN$: $MESSAGE$

この設定をするとProblemsタブでも問題箇所がリストアップされ、本文中には指摘波線が表示されます。いつものInspectionですね。
ただ、なぜかProblemsのリストに同じ問題が2行連続で出力されてしまいます。不具合っぽいのですが、Zenn記事くらいの文章量であれば膨大な指摘でもないのでいったんそのままです。

以上