我如何摆脱 Django 项目中的 Commit-Hook 循环

Source: Dev.to

作为开发者，我们都希望代码干净、统一。pre-commit 之类的工具通过在提交前自动运行 linter、formatter 和其他检查，使这一目标成为可能。然而，如果你在真实项目中使用它们，可能已经遇到过令人头疼的 commit‑hook 循环。

我最近在一个 Django 项目 中遇到了这个问题。下面我将介绍问题的根源以及我的解决方案。

背景

我正在使用典型的 Python 技术栈构建一个 Django 项目：

• Django 5.x
• Python 3.12
• 用于代码格式化的 Black
• 用于代码检查的 Flake8
• 用于导入排序的 isort
• 用于统一管理所有钩子的 pre-commit

目标很简单：在每次提交时自动强制代码质量。

问题：Commit‑Hook 循环

我当时的工作流程是：

git add .
git commit -m "Some message"

此时 pre‑commit 钩子会自动运行。如果某个钩子失败（例如 Black 对文件重新格式化），提交会被中止。于是我需要：

1. 修复问题
2. 再次 git add .
3. 再次 git commit

……如此循环，直到所有钩子通过。对于文件众多的大型 Django 项目，这会导致令人沮丧的 add → commit → fail → fix → add → commit 循环。

解决方案：在提交前先运行 Pre‑Commit

我不再仅依赖提交触发钩子，而是先手动运行 pre‑commit：

pre-commit run --all-files
git add .
git commit -m "Your commit message"

为什么这样更好

• 钩子会在 所有文件 上运行，而不仅仅是已暂存的文件。
• 可自动修复的问题（如格式化）会在提交前被解决。
• 完全避免了提交被拒绝的循环。

更顺手的做法：一条命令搞定

你可以把所有步骤合并为一条命令：

pre-commit run --all-files && git add . && git commit -m "Your commit message"

• 先运行 pre‑commit
• 暂存自动修复的文件
• 干净地提交，不会被中断

可选：在 Push 时强制执行钩子

如果希望团队永远不绕过钩子，可以在 pre‑push 上安装它们：

pre-commit install --hook-type pre-push

这样，每次 push 时也会检查代码质量，为 CI/CD 流水线提供额外的安全网。

最后感想

以这种方式使用 pre‑commit 为我的 Django 项目节省了 数小时的烦恼。关键要点是：

不要等到提交时才发现问题。先运行 pre‑commit，暂存修复，然后再提交。

对于 Django 和 Python 开发者来说，这种工作流让代码 干净、一致、随时可推送，彻底摆脱了可怕的 commit‑hook 循环。

💡 小技巧： 将上述命令设为 git alias 或 shell 脚本，使其成为工作流的无缝一环。久而久之，你几乎感觉不到它的存在——只会感受到它为你节省的时间！