Zenn
💬

textlintとIntelliJと

2021/04/08に公開
textlint
IntelliJ
tech

textlintで記事を読みやすく

https://textlint.github.io/

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

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

以前はVS Codeプラグイン「テキスト校正くん」を使用していたのですが、
今後メインとして使用しているIntelliJ系で文章も書くため、テキスト校正くんの内部で使われている校正プログラムtextlintを設定しました。

textlintインストール

今回導入したルールは、JTF日本語標準スタイルガイド（翻訳用）といくつかの補助的なものです。

$ pnpm install textlint \
  textlint-rule-preset-jtf-style \
  textlint-rule-ja-hiragana-fukushi \
  textlint-rule-ja-hiragana-hojodoushi \
  textlint-rule-ja-hiragana-keishikimeishi \
  textlint-rule-ja-no-redundant-expression \
  textlint-rule-ja-no-weak-phrase \
  textlint-rule-prh
  1. textlint-rule-preset-jtf-style: JTF日本語標準スタイルガイド（翻訳用）のプリセット
  2. textlint-rule-ja-hiragana-*: ひらがなを開く系ルール
  3. textlint-rule-ja-no-*: 推奨されない言い回し表現ルール
  4. textlint-rule-prh: 揺らぎ辞書を扱えるようにするprh

.textlintrc

{
    "rules": {
        "ja-hiragana-keishikimeishi": true,
        "ja-hiragana-hojodoushi": true,
        "ja-hiragana-fukushi": true,
        "ja-no-redundant-expression": true,
        "ja-no-weak-phrase": true,
        "preset-jtf-style": {
            "2.1.2.漢字": true,
            "2.1.5.カタカナ": true,
            "2.1.6.カタカナの長音": true,
            "2.2.1.ひらがなと漢字の使い分け": true
        }
    }
}

preset-jtf-style内で設定しているのは、それぞれの項番で使用するルールです。デフォルトではfalseになっています。

詳細なルールに関しては、textlint-rule-preset-JTF-styleのGitHubリポジトリーをご参照ください。
https://github.com/textlint-ja/textlint-rule-preset-JTF-style

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記事くらいの文章量であれば膨大な指摘でもないのでいったんそのままです。

以上

Discussion