组里几个项目都开始用 pre-commit,用了两个月,感觉最值的不是"代码变干净了",而是不用再在 review 里提格式问题。

装

pipx install pre-commit

pipx 比直接 pip install 好,不会把全局环境搞乱。

配置

项目根目录放一个 .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
  - repo: https://github.com/psf/black
    rev: 24.4.2
    hooks:
      - id: black

第一次提交时它会自己下载依赖,之后就走缓存,速度还可以。

团队里推的时候

一开始总会有人 --no-verify 跳过。与其在群里强调,不如在 CI 里跑同一套检查,本地跳过也过不了 CI,几次之后就没人跳了。

pre-commit run --all-files

另外记得把 .pre-commit-config.yaml 里的 rev 定期更新,不然用的还是半年前的版本。