echonoshy--cgft-llm/03-open-source/docs/pre-commit.md

📘 Pre-commit

一、简介

• 参考文档：

  • Pre-commit 官方文档
  • Git Hook 文档

---

二、基础概念

• Git Hook：Git 提交前/后执行的脚本机制。
• Pre-commit：一个统一管理 Git Hook 的工具，自动执行格式化、检查等操作。
• 优势：自动化、统一规范、减少低级错误。

---

三、快速上手

1. 安装

pip install pre-commit

2. 初始化

pre-commit install

3. 测试运行

pre-commit run --all-files

---

四、配置文件示例

📄 .pre-commit-config.yaml

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer

🔗 更多示例：参考配置文件（fastmcp 项目）

---

五、常用命令

pre-commit run --all-files   # 检查全部文件
pre-commit autoupdate        # 更新 hook 版本
pre-commit install           # 启用钩子
pre-commit uninstall         # 取消钩子
pre-commit clean             # 清除缓存