huskyの基本的な使い方を解説

2022年9月7日

gitのcommitやpushをtriggerにコマンド実行を簡単に行えるhuskyの使い方を解説します。

モグモグさん

類似のライブラリで、simple-git-hooksがあります。

こちらも非常にシンプルに使えるのでおすすめです。

この記事でわかること

huskyとは

gitのcommitやpushといったアクションのタイミングで、コマンドを実行する仕組みを提供するライブラリです。

メモ

内部的には、gitの標準機能であるG it hooksを操作しています。

huskyを導入することで、例えば下記のようなことができるようになります。

こういったことを自動化することで、コードの品質や開発のスピードが向上するので大きなメリットになりますね。

モグモグさん

チームだけではなく個人プロジェクトでも役に立ちますね

それでは、導入の方法と基本的な使い方を解説しています。

// npm
$ npm install husky -D

// yarn
$ yarn husky -D

.husky/というディレクトリが作成され、Git hooksが有効化されます。

# npm 
$ npx husky install

# yarn
$ yarn husky install

husky add で実行タスクを追加できます。

コミット前のタスクを追加

# npm
$ npx husky add .husky/pre-commit "実行したいコマンド"

# yarn
yarn husky add .husky/pre-commit "実行したいコマンド"

push前のタスクを追加

# npm
$ npx husky add .husky/pre-push "実行したいコマンド"

# yarn
yarn husky add .husky/pre-push "実行したいコマンド"

すると下記のようなファイルが出来上がり、任意のタイミングでコマンドが実行されるようになります。

#!/usr/bin/env sh
"$(dirname -- "$0")/_/husky.sh"

// 実行コマンドの例
npx --no -- commitlint --edit

gitのcommitやpushをtriggerにコマンド実行を簡単に行えるhuskyの使い方を解説しました。

husky を導入することで、コードの品質や開発スピードの向上が見込めますので気になる方は導入してみてください。