Markdownでブログを書く際に日本語の間違いやtypoをチェックできるようにtextlintを導入した.
textlintとは#
テキストやMarkdownに書かれた自然言語文章をルールに従ってチェックしてくれるツール.
インストールと設定#
textlintとルールプリセットをglobalオプションでインストール.
$ npm install -g \
textlint \
textlint-rule-preset-ja-technical-writing \
textlint-rule-spellcheck-tech-word
そのままだとルールが適用されないので.textlintrc
を用意する.今回使用したプリセットルールは以下.
$ cat ~/.textlintrc
{
"rules": {
"preset-ja-technical-writing": {
"sentence-length": {
max: 140
},
"ja-no-mixed-period": {
"allowPeriodMarks": ["."]
}
},
"textlint-rule-spellcheck-tech-word": true
}
}
preset-ja-technical-writing
では技術文書向けのルールが複数内包されている.
READMEにも書いてあるがデフォルトでは厳しめのルールになっているため,個別にsentence-length
を140文字まで許容,ja-no-mixed-period
での文末の句読点を。
に加えて.
も許容する設定にした。
Vimで非同期にtextlintする#
Vim プラグインマネージャーはjunegunn/vim-plugを,Lint エンジンにdense-analysis/aleを使用している.
".vimrcから抜粋
" vim-plugでのインストール
Plug 'w0rp/ale'
" ale linterの設定
let g:ale_linters = {
\ 'markdown': ['textlint']
\}
これでMarkdownの文章を非同期チェックできるようになった.