textlintによる日本語校正のしくみが素敵すぎる


textlint」というMarkdownなどのテキスト向けのLintツールの紹介です。
つまり、Markdownの日本語の文章の表記ゆれや誤記などのエラーを出してくれたり、自動で修正を行ってくれるツールです。


🐝 インストール手順

まずは、 textlint と日本語用のライブラリをいくつかインストールします。

npm i -g textlint
npm i -g textlint-rule-max-ten textlint-rule-spellcheck-tech-word
npm i -g textlint-rule-no-mix-dearu-desumasu textlint-rule-prh

ライブラリの概要はこんな感じです。

次に、.textlintrc という設定ファイルを作ります。

// .textlintrc
{
"rules": {
"max-ten": {
"max": 3
},
"spellcheck-tech-word": true,
"no-mix-dearu-desumasu": true,
"prh": {
"rulePaths": [
"./prh.yml"
]
}
}
}

チェックをコマンド上で行う手順はこちら。

textlint README.md

--fix オプションをつけると自動修正もやってくれます。

😼 初期設定で参考になりそうなプロジェクト

初期設定としてはかなり参考になりました。ありがたい限りです!

📚 おすすめの書籍

🖥 サーバについて

このブログでは「Cloud Garage」さんのDev Assist Program(開発者向けインスタンス無償提供制度)でお借りしたサーバで技術検証しています。 Dev Assist Programは、開発者や開発コミュニティ、スタートアップ企業の方が1GBメモリのインスタンス3台を1年間無料で借りれる心強い制度です!(有償でも1,480円/月と格安)