【husky】コミットと同時にESLint、プッシュと同時にJestを自動で走らせる

Posted at 2022-07-25

作成したNext.jsのプロジェクトにhuskyを用いて以下の機能を追加します。

commit時にESLintを走らせてerrorがあればcommitさせない
push時にJestを走らせてerrorがあればpushさせない

huskyとは
コミットやプッシュの前にテストなどを実行して、失敗したら止めることができる Git hooks を簡単に設定することができるツール。

導入手順

※以下yarnを使用したhuskyの導入についての説明をしていきます。

① lint-stagedの導入

$ npx mrm lint-staged

② NPM スクリプトに追加

package.json

{
  "scripts": {
    "lint-staged": "lint-staged"
  }
}

③husky の追加

$ yarn add -D  husky@next

④Git hooks の有効化

$ yarn husky install

⑤package.jsonに追加

package.json

~~
"husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "pre-push": "yarn test"
    }
  }

~~

以上です。

.git/hooks が正常に作成されていない可能性があります。
以下コマンドで確認しましょう。

$ ls -la .git/hooks/ls -la .git/hooks/

.sample しかなかったら再度huskyをインストールしましょう。

$ yarn remove huksy