在Windows上使用Python script git hook

之前在工作上其實就有碰到需要使用 git hook 的時候，那時候有發現，在 Linux 和 MacOS 上執行順暢的 hook，到了 Windows 上卻完全不管用。當時因為在 Windows 上執行的需求不強，就暫時擱置到現在，有需要了，就開始認真研究。

研究後發現 Windows 的不僅要繞一個彎，還有很多奇怪的小問題，不過目前實作起來還好，就順手記錄下提供給有需要的人參考。

前置作業

本文不講解 git hook 是做什麼用途或是可以幹嘛的，假定你已經寫好一個 hook 了，那麼就可以繼續往下看；還沒的話，後面的步驟就只能先備而不用了。

本文使用 Python 寫成的 commit-msg hook 做示範，檔案就是直接複製 sample 出來寫的 commit-msg

#!/usr/bin/env python3


import re
import sys


sys.stdout.reconfigure(encoding='utf-8')


with open(sys.argv[1], encoding = "utf-8") as cm:  # commit message
    lines = cm.readlines()
    if not re.search(r'^([a-z].{1,}:) .{1,}', lines[0]):
        print("Fail!")
        exit(1)

實作

以下都以剛剛提到的規格講解，請自己代換成自己的規格。

有兩步驟，做好就完成了：

原本的 hook 改名（但不可和 hook 規範衝突）
複製出新的 hook 來執行實際邏輯所在的檔案

下面是詳細說明。

hook改名

將原本的 Python commit-msg hook 從 commit-msg 改名為 commit-msg.py。例如你是用 Node 寫的，那可能就是改成 commit-msg.js 這樣的感覺。

總之就是要和原本的 hook 名稱不一樣或是不和規定好的 hook 命名規範衝突即可。

複製新hook

把原本的 commit-msg.sample 複製出來成新的 hook，除了 shebang 外的東西都可刪除（shebang 不用變更），然後看要怎麼執行你剛剛改名好的檢查邏輯所在的檔案。以本文範例是 Python 來說：

#!/bin/sh

# 不同作業系統的 Python 名稱或別名不同
if [ "$OSTYPE" == "msys" ]; then
    python='py'
else
    python='python3'
fi

# 因為 commit-msg hook 需要一個參數讓提交訊息傳入，所以給他第一個變數作為參數傳進去
${python} .git/hooks/commit-msg.py $1