今回は、エンジニアにもライターにも人気の「textlint」の使い方と、すぐに使えるおすすめ設定をご紹介します。
textlintって何?
textlint
は、文章の自動校正をしてくれるオープンソースツールです。
たとえば、次のようなミスを指摘してくれます:
- 助詞の重複(「がが」「のの」など)
- 文章が長すぎる
- 日本語と英語の記号の混在
コーディングのLintツールの「文章版」だと思えばOK!
インストール方法(グローバル)
まずはターミナルで以下をコピペして、インストールしましょう。
npm install -g \
textlint \
textlint-rule-preset-ja-technical-writing \
textlint-rule-spellcheck-tech-word
インストールが完了したら、バージョン確認もしておきましょう。
textlint --version
おすすめ設定ファイル .textlintrc
以下のように .textlintrc
ファイルを用意するだけで、かなり高精度なチェックができます。
{
"filters": {
"comments": true
},
"rules": {
"preset-ja-technical-writing": {
"no-doubled-joshi": true,
"sentence-length": {
"max": 100
},
"no-exclamation-question-mark": true,
"no-mixed-zenkaku-and-hankaku-alphabet": true,
"ja-no-mixed-period": true,
"ja-unnatural-alphabet": true
},
"spellcheck-tech-word": {
"skipPatterns": [
"/[0-9]+/",
"/[a-zA-Z]{2,}/"
]
}
}
}
この設定では、技術文書向けのルールを中心に、助詞の重複や表記のゆれなどをしっかりチェックしてくれます。
実行方法
文章ファイルをチェックしたいときは、次のコマンドを実行します。
textlint your-article.md
Markdownやテキストファイルでの原稿執筆にピッタリです。
実行例
たとえば、example.md
というMarkdownファイルをチェックしたい場合、次のように実行します。
textlint example.md
問題がある場合、以下のような出力がされます:
example.md
3:15 ✓ 助詞 "の" が連続して使われています。 preset-ja-technical-writing/no-doubled-joshi
8:5 ✓ 一文が長すぎます(120文字)。100文字以下に分割を検討してください。 preset-ja-technical-writing/sentence-length
問題がなければ、出力はなく、そのまま終了します。
チェック結果に応じて、文章を修正し、再度 textlint
を実行すればOKです。
おまけ:VS Code連携もおすすめ!
Visual Studio Codeを使っている人は、textlint extensionをインストールすると、リアルタイムで赤線チェックが入るようになります。これが非常に便利!
まとめ
textlint
は文章のLintツールで、文章の質をグッと引き上げてくれる- インストール&設定も簡単!すぐに使える
.textlintrc
を整えれば、精度の高いチェックが可能- VS Codeと組み合わせると効率UP
ちょっとした文章のミスも、自分ではなかなか気づきにくいもの。textlint
を使えば、品質の高い文章を効率よく書けるようになりますよ。ぜひ一度、導入してみてください!