textlintを使ってブログの表記揺れをなくす
3月頭から@kakakakakkuさんにブログメンタリングをしていただいています。その中でよくご指摘いただく事項に表記揺れがありました。 そんな時に役立つ文書校正ツールのtextlintについて紹介します。
textlintとは
特定のルールにしたがって自然言語をチェックしてくれます。 CLI経由でも利用できますし、Visual Studio CodeやAtomとの連携も可能です。
環境
textlintはnpm経由でインストールします。今回は特定のフォルダ内のあるマークダウンファイルを対象とし、
~/blog
というリポジトリの中に~/blog/textlint.md
を作成したとして進めます。Node.jsはインストールされているとします。
npm -v #6.5.0
手順
まず、package.json
の生成をします。
npm init --yes
このコマンドでpackage.json
が生成されます。
次に、textlintをインストールします。
npm install --save-dev textlint
次に、ルールをインストールします。
結論から言うと、技術ブログの校正であればtextlint-rule-proofdict
とtextlint-rule-preset-ja-technical-writing
でことたりそうです。
npm install --save-dev textlint-rule-proofdict textlint-rule-preset-ja-technical-writing
次に、textlintのルールを有効にするファイルを生成します。
npx textlint --init
このコマンドで.textlintrc
が生成されます。
最後に、textlint-rule-proofdictの辞書の設定をします。
こちらにあるようにリポジトリをforkして細かく表記揺れ検知の設定をすることも可能です。 .textlintrc
"filters": {}, "rules": { "preset-ja-technical-writing": true, "proofdict": { "dictURL": "https://azu.github.io/proof-dictionary/" } } }
実際に使う
npx textlint textlint.md
自動修正も可能です。
npx textlint --fix textlint.md
Visual Studio Codeでの使用
vscode-textlint
という拡張機能を入れます。
これだけで.textlintrc
の配置されているプロジェクトを開くと、リアルタイムで画像のように校正されます。
まとめ
textlintを使用することで表記揺れを減らすことができ、ブログを見直す時の心理的ハードルが下がりました。 ぜひ導入してみてください。