hiro08gh

ソフトウェアに関すること

huskyでgit commit時にnpm testを走らせる

こんにちはかみむらです。
OSSのライブラリを見回ってたときにhuskyというライブラリの存在を知りました。調べてみると、スターが1万ついてる有名ライブラリみたいです。概要はgitコマンドをhookにして、指定したコマンドを走られることができます。例えばコミット時にlinterとtestを走らせたり、push時にtestを走らせたりです。それでは簡単に見ていきましょう。
huskyのgithubページ
github.com

インストール

npmまたはyarnでインストールします
npm install --save-dev husky
or
yarn add -D husky

使用方法

huscyのgithubページにある例を参考にしていきます。package.jsonに下記を追記します。これでコミット時とpush時に、npm testを実行することができます。

// package.json
{
  "husky": {
    "hooks": {
      "pre-commit": "npm test",
      "pre-push": "npm test",
      "...": "..."
    }
  }
}

実際にコミットすると実行できます。

$ git commit -m "test commit"