textlintで遊ぼう

Qiita:Team + Hubot + textlintで文章校正を自動で実行するという記事に触発されたので、textlintしてみよう。

事前準備

nvmのインストール。

textlintにはNode.jsが必要。それだけを準備しても良いのだけど、Node.jsを含む関連ライブラリのバージョン管理してくれる NVM (Node Version Manager を入れておくと便利っぽいので入れておきます。

cd
git clone https://github.com/creationix/nvm.git ~/.nvm
source ~/.nvm/nvm.sh

上記実行後、下記設定を ~/.zshrc に追加しておこう。

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" # This loads nvm

Node.jsのインストール。

nvm install node

本題（textlint周り）

textlintとお試しルールのインストール。

デフォルトではtextlintでチェックするためのルールがないので、ここではtextlint-rule-preset-japanese、textlint-rule-preset-ja-technical-writingとtextlint-spellcheck-tech-wordを入れてます。インストール時にtextlintバージョン周りのwarning出ても、気にしないのが吉かも。多分。4行目のtextlint-spellcheck-tech-wordはインストールでコケるのでコメントアウトしてます。あとtextlintを「-gオプション (global install)」付きでインストールしたのなら、ルールも同じようにインストールする必要があるらしい。

npm install textlint -g
npm install --save textlint-rule-preset-japanese -g
npm install --save textlint-rule-preset-ja-technical-writing -g
# npm install --save textlint-spellcheck-tech-word -g

インストールできたら、以下の設定を ~/.textlintrc に保存。

{
    "rules": {
        "spellcheck-tech-word": true,
        "preset-ja-technical-writing": true
    }
}

動作確認

適当なテキストファイルかMarkdownファイルを用意して、コマンドラインで以下のように実行。ちゃんと動くなら、~/.textlintrcでtrue設定したルールを適用した結果が出力されるはず。

textlint filename.txt

参考サイト

• Qiita:Team + Hubot + textlintで文章校正を自動で実行する
• textlintで日本語の自動校正サービスを作ってみた！
• textlintで日本語の文章をチェックする
• いまアツいJavaScript！ゼロから始めるNode.js入門〜5分で環境構築編〜
• textlintで日本語の文章を校正する方法とAtomへの導入手順

一応textlint自体は動くっぽいのだけど、ルールどうしよっかなー。