透過 pre-commit 自動執行格式檢查與測試，減少低級錯誤。
簡單安裝、快速設定，馬上提升程式碼品質。

pre-commit 是一個 Git Hooks ，會在 commit 前執行。
可以自訂要執行的指令，通常是提升程式碼品質的格式檢查或是單元測試。

安裝

可以用 Homebrew 安裝

brew install pre-commit

也可以用 pip 或是 pipx 安裝

pip install pre-commit
pipx install pre-commit

在專案中新增 pre-commit Hook

pre-commit install

設定 pre-commit

編輯專案根目錄下的設定檔 .pre-commit-config.yaml 加入自己想使用的工具

這邊使用 python 的 isort 和 black 做排版檢查做示範

repos:
  - repo: https://github.com/PyCQA/isort
    rev: 6.0.1
    hooks:
      - id: isort
        args: ["--profile", "black", "--filter-files"]

  - repo: https://github.com/psf/black
    rev: 23.1.0
    hooks:
      - id: black

手動執行 dry run

pre-commit run --all-files

如果有什麼很急的事情一定要繞過檢查，可以在 commit 時使用 --no-verify

git commit --no-verify