Lefthook

2022-04-20 hit count image

Lefthookを使ってGitのcommitを実行する時、テストやLinterを実行するように設定する方法について説明します。

概要

フロントエンドの開発する時、Huskylint-stagedを使ってGitcommitを実行する時、自動でESLintPrettierを実行するように設定して使っていました。

最近はGolangを使ってウェブサーバを開発したり、Flutterを使ってアプリを開発してますが、NodeベースではないプロジェクトでHuskyとlint-stagedのようにLinterやテストコードを実行する方法が必要にあんりました。

今回のブログポストではLefthookを使ってGitのcommitを実行する時、Linterやテストコードを実行する方法を共有します。

Lefthookのインストール

Lefthookは色んな言語やOSをサポートしています。自分の開発環境に合わせてLefthookをインストールしてください。

私はmacOSを使っているので、次のコマンドを実行してLefthookをインストールしました。

brew install lefthook

Lefthookの設定

このように設定したLefthookを使うためには、開発しているプロジェクトのフォルダに./lefthook.ymlファイルを作って次のように修正する必要があります。

pre-commit:
  parallel: true
  commands:
    pretty:
      glob: './src/**'
      run: npx prettier --check {staged_files}
    linter:
      glob: 'src/**/*.{ts,tsx}'
      run: npx eslint {staged_files}

pre-commitまたはpre-pushを使ってGitのcommitやpush以前に特定動作をするように設定することができます。parallelオプションを使うと実行するコマンドを並列で実行できるように設定することができます。commadsには特定アクションの名前(pretty, linterなど)に実行するコマンド(run)を設定することができます。

globを使うとファイルリストをフィルタリングすることができますし、rootオプションを使うとコマンドを実行するフォルダを指定することができます。

pre-commit:
  commands:
    backend-linter:
      root: "api/" # Careful to have only trailing slash
      glob: "*.rb" # glob filter
      run: bundle exec rubocop {all_files}

これ以外にも次のような機能を使えます。

Lefhookの実行

このように設定したLefthookが上手く実行できるか確認するため次のコマンドを実行してみます。

lefthook run pre-commit

そしたら、./lefthook.ymlに設定したコマンドが実行されることが確認できます。

Lefthookの適用

lefthook run ...コマンドは./lefthook.ymlファイルの内容を1回だけ実行します。しかし、私たちはGitcommitが実行されるたびに./lefthook.ymlファイルに設定したコマンドを実行するように作りたいです。今度は次のコマンドを実行してGitcommitが実行される時、./lefthook.ymlに設定したコマンドが実行されるように設定します。

lefthook install

今後、Gitcommitコマンドを実行すると、./lefthook.ymlに設定したコマンドが実行されることが確認できます。

完了

これでLefthookを使ってGitcommitを実行する時、Linterとテストコード実行などのコマンドを実行する方法について説明しました。Lefthookは色んな開発環境をサポートしてるので、Node開発環境ではないプロジェクトでも使えます。

私のブログが役に立ちましたか?下にコメントを残してください。それは私にとって大きな大きな力になります!

アプリ広報

今見てるブログを作成たDekuが開発したアプリを使ってみてください。
Dekuが開発したアプリはFlutterで開発されています。

興味がある方はアプリをダウンロードしてアプリを使ってくれると本当に助かります。

Posts