Gitのpre-commitフックでコミット前にチェックする方法
Git の pre-commit フックは、git commit がコミットを作る直前に実行されるスクリプトです。スクリプトが 0 以外の終了コードで終わると、コミットは作られずに止まります。console.log の消し忘れや行末の空白のように、コミットする前に自動でチェックして、見つけたらコミットを止めたいときに使う仕組みです。ここでは、試験用のリポジトリ cat-app に .git/hooks/pre-commit を書いて、フックがないときとあるときの git commit の出力を見比べました。
検証環境は Ubuntu 24.04、Git 2.43.0 です。作者の名前とメールアドレスは例示用の値(Neko <neko@example.com>)にしました。システム全体の設定ファイルは読まない状態(GIT_CONFIG_NOSYSTEM=1)で試しています。フックはシェルスクリプト(#!/bin/sh)で書きました。Windows・macOS での動作や、Husky などフックを管理するツールは試していません。

フックの置き場所は .git/hooks
git init で作ったリポジトリの .git/hooks には、最初からサンプルのスクリプトが入っています。git init の公式リファレンスによると、サンプルはどれも最初は使われない状態で、使うには名前の末尾の .sample を外します。
$ ls .git/hooks
applypatch-msg.sample
commit-msg.sample
fsmonitor-watchman.sample
post-update.sample
pre-applypatch.sample
pre-commit.sample
pre-merge-commit.sample
pre-push.sample
pre-rebase.sample
pre-receive.sample
prepare-commit-msg.sample
push-to-checkout.sample
sendemail-validate.sample
update.sample
githooks の公式リファレンスによると、フックの置き場所は、設定を変えなければ .git/hooks です。pre-commit という名前(拡張子なし)のファイルを置いて実行権限を付けると、git commit のたびに実行されます。
pre-commit を書く
ここでは、次の2つをチェックするフックを .git/hooks/pre-commit に書きました。
- ステージした
.jsファイルにconsole.logが残っていないか - ステージした変更に、行末の空白などがないか
$ cat .git/hooks/pre-commit
#!/bin/sh
# ステージした内容に console.log が残っていたら、コミットを止める
if git grep --cached -n 'console\.log' -- '*.js'; then
echo "pre-commit: console.log が残っているので、コミットを止めました" >&2
exit 1
fi
# 行末の空白などがあれば、コミットを止める
exec git diff --cached --check
git grep は、見つかったときに 0、見つからなかったときに 1 で終わりました。そのため if の中は、console.log が見つかったときだけ実行されます。最後の git diff --cached --check は、ステージした変更に行末の空白などがあると 0 以外で終わります。exec で実行しているので、その終了コードがそのままフックの終了コードになります。
実行権限がないと、フックは飛ばされる
ファイルを書いただけでは、実行権限が付いていません。この状態で、console.log を含む変更をステージしてコミットしました。
$ ls -l .git/hooks/pre-commit | cut -c1-10
-rw-r--r--
$ printf "export const bye = (name) => \`Bye, \${name}\`;\nconsole.log(bye(\"Tama\"));\n" >> app.js && git add app.js && cat app.js
export const greet = (name) => `Hello, ${name}`;
export const bye = (name) => `Bye, ${name}`;
console.log(bye("Tama"));
$ git commit -m "bye を追加"; echo "exit=$?"
hint: The '.git/hooks/pre-commit' hook was ignored because it's not set as executable.
hint: You can disable this warning with `git config advice.ignoredHook false`.
[main 51e1dcc] bye を追加
1 file changed, 2 insertions(+)
exit=0
hint: の行で「実行権限がないのでフックを無視した」と知らせたうえで、コミットはそのまま作られました。githooks の公式リファレンスにも、実行権限のないフックは無視されると書かれています。このコミットは git reset --soft HEAD~1 で取り消し、変更はステージしたままにしました。
$ git reset -q --soft HEAD~1 && git log --oneline && git status --short
4ab96d1 最初のコミット
M app.js
実行権限を付けると、コミットが止まる
chmod +x で実行権限を付けて、同じ変更をもう一度コミットしました。
$ chmod +x .git/hooks/pre-commit && ls -l .git/hooks/pre-commit | cut -c1-10
-rwxr-xr-x
$ git commit -m "bye を追加"; echo "exit=$?"
app.js:3:console.log(bye("Tama"));
pre-commit: console.log が残っているので、コミットを止めました
exit=1
フックが出したメッセージが表示され、git commit は 1 で終わりました。履歴は増えておらず、変更はステージされたまま残っています。
$ git log --oneline
4ab96d1 最初のコミット
$ git status --short
M app.js
console.log の行を消してステージし直すと、今度はコミットできました。
$ sed -i "/console.log/d" app.js && git add app.js && cat app.js
export const greet = (name) => `Hello, ${name}`;
export const bye = (name) => `Bye, ${name}`;
$ git commit -m "bye を追加"; echo "exit=$?"
[main 7e03933] bye を追加
1 file changed, 1 insertion(+)
exit=0
行末の空白も止まる
次に、行末に空白が2つある行を足してコミットしました。git diff --cached --check が、ファイル名と行番号を出してコミットを止めました。
$ printf "export const hi = (name) => \`Hi, \${name}\`; \n" >> app.js && git add app.js
$ git commit -m "hi を追加"; echo "exit=$?"
app.js:3: trailing whitespace.
+export const hi = (name) => `Hi, ${name}`;
exit=1
git diff の –check の説明によると、--check は既定で、行末の空白のほか、行頭のインデントでスペースの直後にタブがある場合と、コンフリクトマーカー(<<<<<<< などの行)も見つけます。行末の空白を消してステージし直すと、コミットできました。
$ sed -i "s/[[:space:]]*$//" app.js && git add app.js && git commit -m "hi を追加"; echo "exit=$?"
[main 7a00d47] hi を追加
1 file changed, 1 insertion(+)
exit=0
作業ツリーではなく、ステージした内容を調べる
コミットされるのは、作業ツリーのファイルではなく、ステージした内容です。フックのチェックで --cached を付けているのはそのためです。違いが出る場面を作って確かめました。console.log の行を足してステージしたあと、作業ツリーのファイルからだけその行を消します。
$ printf "console.log(hi(\"Tama\"));\n" >> app.js && git add app.js && sed -i "/console.log/d" app.js
$ git status --short
MM app.js
git diff --cached(ステージした内容と最新のコミットの差分)には console.log の行が足されていて、git diff(作業ツリーとステージした内容の差分)では、その行が消えています。2つの違いは、git diff の公式リファレンスの最初のほうで説明されています。
$ git diff --cached
diff --git a/app.js b/app.js
index 942c743..818ade8 100644
--- a/app.js
+++ b/app.js
@@ -1,3 +1,4 @@
export const greet = (name) => `Hello, ${name}`;
export const bye = (name) => `Bye, ${name}`;
export const hi = (name) => `Hi, ${name}`;
+console.log(hi("Tama"));
$ git diff
diff --git a/app.js b/app.js
index 818ade8..942c743 100644
--- a/app.js
+++ b/app.js
@@ -1,4 +1,3 @@
export const greet = (name) => `Hello, ${name}`;
export const bye = (name) => `Bye, ${name}`;
export const hi = (name) => `Hi, ${name}`;
-console.log(hi("Tama"));
この状態で git grep を --cached なしで実行すると、作業ツリーのファイルを調べるので何も見つかりません。--cached を付けると、ステージした内容から見つかりました。
$ git grep -n "console\.log" -- "*.js"; echo "exit=$?"
exit=1
$ git grep --cached -n "console\.log" -- "*.js"; echo "exit=$?"
app.js:4:console.log(hi("Tama"));
exit=0
--cached なしの git grep は、このとおり console.log を見つけません。フックは --cached 付きで調べているので、コミットを止めました。
$ git commit -m "動作確認を追加"; echo "exit=$?"
app.js:4:console.log(hi("Tama"));
pre-commit: console.log が残っているので、コミットを止めました
exit=1
–no-verify を付けると、フックを飛ばしてコミットする
どうしても今コミットしたいときは、git commit に --no-verify(短く書くと -n)を付けると、pre-commit フックを実行せずにコミットします。git commit の公式リファレンスによると、このオプションは pre-commit と commit-msg の2つのフックを飛ばします。
$ printf "console.log(hi(\"Tama\"));\n" >> app.js && git add app.js
$ git commit --no-verify -m "動作確認を追加"; echo "exit=$?"
[main 907ee0b] 動作確認を追加
1 file changed, 1 insertion(+)
exit=0
$ git log --oneline
907ee0b 動作確認を追加
7a00d47 hi を追加
7e03933 bye を追加
4ab96d1 最初のコミット
フックのメッセージは出ず、console.log を含んだコミットができました。確かめたあと、このコミットは取り消しています。
フックをリポジトリに入れて共有する(core.hooksPath)
.git/hooks の中身は、git clone では複製されません。フックを置いたリポジトリ cat-app を cat-app-2 に複製すると、cat-app-2 の .git/hooks にはサンプルしかありませんでした。
フックをチームで共有するには、フックをリポジトリの中のフォルダー(ここでは .githooks)に入れてコミットし、core.hooksPath でそのフォルダーを指定します。まず cat-app で、実行権限の付いたフックを .githooks にコピーしてコミットしました。ファイルのモードが 100755(実行権限あり)で記録されています。
$ mkdir .githooks && cp .git/hooks/pre-commit .githooks/pre-commit && git add .githooks && git commit -m "pre-commit フックを追加"
[main 459a1a6] pre-commit フックを追加
1 file changed, 9 insertions(+)
create mode 100755 .githooks/pre-commit
$ git ls-files -s .githooks
100755 b51cf132f987e09527a13b5e70a5be50beaec555 0 .githooks/pre-commit
cat-app の1つ上のフォルダーで、cat-app-2 に複製しました。複製のあとのコマンドは cat-app-2 の中で実行しています。.githooks/pre-commit は実行権限付きで取り出されましたが、.git/hooks にはサンプルしかありません。
$ git clone -q cat-app cat-app-2
$ ls .git/hooks
applypatch-msg.sample
commit-msg.sample
fsmonitor-watchman.sample
post-update.sample
pre-applypatch.sample
pre-commit.sample
pre-merge-commit.sample
pre-push.sample
pre-rebase.sample
pre-receive.sample
prepare-commit-msg.sample
push-to-checkout.sample
sendemail-validate.sample
update.sample
$ ls -l .githooks/pre-commit | cut -c1-10
-rwxr-xr-x
このままでは .githooks のフックは使われず、console.log を含む変更もコミットできてしまいました。
$ printf "console.log(greet(\"Tama\"));\n" >> app.js && git add app.js
$ git commit -m "動作確認を追加"; echo "exit=$?"
[main 419d58c] 動作確認を追加
1 file changed, 1 insertion(+)
exit=0
このコミットを git reset --soft HEAD~1 で取り消してから、core.hooksPath に .githooks を設定しました。同じ変更のコミットが、フックで止まりました。
$ git config core.hooksPath .githooks && git config --show-scope --get core.hooksPath
local .githooks
$ git commit -m "動作確認を追加"; echo "exit=$?"
app.js:4:console.log(greet("Tama"));
pre-commit: console.log が残っているので、コミットを止めました
exit=1
core.hooksPath の説明によると、相対パスはフックが実行されるフォルダーを基準にします。githooks の公式リファレンスによると、通常のリポジトリでは、フックは作業ツリーのいちばん上のフォルダーで実行されます。サブフォルダー src に入ってからコミットしても、.githooks のフックが動き、リポジトリのいちばん上にある app.js を見つけました。
$ mkdir -p src && cd src && git commit -m "動作確認を追加"; echo "exit=$?"
app.js:4:console.log(greet("Tama"));
pre-commit: console.log が残っているので、コミットを止めました
exit=1
core.hooksPath は、--show-scope で local と表示されたとおり、そのリポジトリの設定です。次のコマンドは、リポジトリの1つ上のフォルダーで実行しました。cat-app にも core.hooksPath を設定してから cat-app-3 に複製すると、複製した側では設定が空でした(ここでは git config --get が何も出さず、1 で終わりました)。
$ cd cat-app && git config core.hooksPath .githooks && git config --show-scope --get core.hooksPath
local .githooks
$ git clone -q cat-app cat-app-3
$ cd cat-app-3 && git config --get core.hooksPath; echo "exit=$?"
exit=1
フックのファイルはリポジトリと一緒に届きますが、core.hooksPath は複製した人がそれぞれ設定します。設定するまでは、上で見たように .githooks のフックは動きません。





