git commitするとtextlintが実行されるようにする

koushikagawa 2022/04/25に更新

目標

git commit するとtextlintが実行される

やること

textlint導入
textlintルール設定
git commit時にtextlint実行されるようにする

koushikagawa 2022/04/25

textlint導入

下記実行

npm init
npm install --save-dev textlint

インストールされているか確認。

npx textlint -v
v12.1.1

koushikagawa 2022/04/25

textlintルール設定

今回は下記を設定する

preset-ja-technical-writing

下記実行

npm install --save-dev textlint-rule-preset-ja-technical-writing

設定ファイルを有効化

下記を実行し、.textlintrcを作成する

npx textlint --init

.textlintrcを確認すると、下記が記載されている。

{
  "filters": {},
  "rules": {
    "preset-ja-technical-writing": true
  }
}

参考

設定できるルールは下記を確認する。

koushikagawa 2022/04/25に更新

一旦実行確認

適当なmdファイルを作成する。
今回は docs/text.md ファイルを作成

今日は天気が良い。
今日は天気が良いです。
今日は天気が良い。。。

下記実行

npx textlint docs/test.md

メッセージ表示されました。

  8:10  error  "。" が連続して2回使われています。  ja-technical-writing/ja-no-successive-word
  8:11  error  "。" が連続して2回使われています。  ja-technical-writing/ja-no-successive-word

完成。次にgit commit 時に実行されるように設定する。