用 pre-commit 钩子,把代码问题挡在提交之前

举报
yd_273709801 发表于 2026/11/05 09:10:50 2026/11/05
【摘要】 为什么需要提交前检查代码风格不统一、忘删调试语句、把密钥误提交进仓库,这些问题如果等到 Code Review 或 CI 才发现,往往要来回返工。Git 自带的 hooks 机制允许在 commit 前自动运行脚本,而 pre-commit 框架让这件事变得简单、可共享。 快速上手安装:pip install pre-commit在项目根目录创建 .pre-commit-config.ya...

为什么需要提交前检查

代码风格不统一、忘删调试语句、把密钥误提交进仓库,这些问题如果等到 Code Review 或 CI 才发现,往往要来回返工。Git 自带的 hooks 机制允许在 commit 前自动运行脚本,而 pre-commit 框架让这件事变得简单、可共享。

快速上手

  1. 安装:pip install pre-commit
  2. 在项目根目录创建 .pre-commit-config.yaml:
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.6.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: detect-private-key
  1. 执行 pre-commit install,之后每次 git commit 都会自动检查暂存的文件。

实用技巧

  • 首次接入时运行 pre-commit run --all-files,一次性清理存量问题。
  • 可以按语言接入格式化和静态检查工具,比如 Python 的 black、ruff,前端的 prettier、eslint。
  • 配置文件随仓库提交,团队成员只需执行一次 install 就能共用同一套规则。
  • 紧急情况下可以用 git commit --no-verify 跳过检查,但别让它成为习惯。

小结

pre-commit 把「靠人记得」变成「靠工具保证」,成本低、见效快。建议在 CI 里也运行同样的检查,本地和远端双重把关。

【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0)

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。