代码守护者：用git pre-commit-hook提升开发品质

同步发表在我的个人站点：https://panzhixiang.cn

在日常开发中，我们总是希望代码质量尽可能高，问题尽可能少。为了实现这一目标，git pre-commit-hook成为了我们的得力助手。通过在git commit操作前执行一系列检查，我们可以确保只有符合标准的代码才能被提交和推送到代码库。这种做法不仅有助于及时发现并解决问题，还能减少后续的code review工作量。

以下是我常用的pre-commit配置实践，它包括了代码风格检查、秘钥检查、代码格式化等关键步骤。通过这些步骤，我们可以在代码进入仓库之前，确保其符合团队的内部约定和策略

首先，需要在仓库的根目录下创建一个 .pre-commit-hook.yaml 文件， 我常用的配置如下：

---
exclude: "docs|node_modules|migrations|.tox"
default_stages: [commit]
fail_fast: false

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0
    hooks:
      - id: fix-encoding-pragma
        args: ["--remove"]
      - id: check-case-conflict
      - id: check-docstring-first
      - id: check-merge-conflict
        exclude: /README\.rst$|^docs/.*\.rst$
      - id: check-symlinks
      - id: check-xml
      - id: mixed-line-ending
        args: ["--fix=lf"]
      - id: detect-private-key
        exclude: ^xxxxxxx/secrets_detection\.py$ 

  - repo: https://github.com/myint/autoflake
    rev: v2.0.2
    hooks:
      - id: autoflake
        args: ["--in-place", "--remove-all-unused-imports", "--remove-duplicate-keys"]

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

  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
        args: ["--profile", "black"]

  - repo: https://github.com/pycqa/flake8
    rev: 3.9.2
    hooks:
      - id: flake8
        additional_dependencies:
          - flake8-pie
          - flake8-print

  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
    rev: v9.11.0
    hooks:
      - id: commitlint
        stages: [commit-msg]
        additional_dependencies: ["conventional-changelog-conventionalcommits"]
        args: ["--config", "dev/ci/commitlint.yaml"]

  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: "v0.0.260"
    hooks:
      - id: ruff
        args: 
          - --fix
          - --exit-non-zero-on-fix
          - --extend-select=E
          - --extend-ignore=E501
          - --extend-select=F
          - --extend-select=I
          - --extend-select=N
          - --extend-select=W
          - --extend-select=S
          - --per-file-ignores="**/test*.py:S101"
          - --extend-exclude=migrations

  - repo: https://github.com/Yelp/detect-secrets
    rev: v0.14.3
    hooks:
      - id: detect-secrets
        args: ['--baseline', '.secrets.baseline']

在pre-commit配置文件中，每个repo代表的是一个包含多个hooks的代码库，hooks可以理解为实际执行检查的工具或脚本。下面我会逐一解释配置文件中的repo和hook：

1. https://github.com/pre-commit/pre-commit-hooks：这个库包含了一些常用的hooks，用于完成很多基本的代码检查和修复。在配置文件里用到的hooks有：

   • fix-encoding-pragma：移除python文件中的编码声明。
   • check-case-conflict：检查是否存在因大小写造成的文件冲突。
   • check-docstring-first：检查模块、类或者函数是否以文档字符串开始。
   • check-merge-conflict：查找并报告git合并冲突。
   • check-symlinks：检查无效的符号链接。
   • check-xml：检查XML文件的有效性。
   • mixed-line-ending：检查并修复文件的行尾结束符。
   • detect-private-key：检测是否有私钥被提交。

2. https://github.com/myint/autoflake：autoflake是一个Python工具，用于移除Python代码中未使用的导入，以及未使用的变量。配置中的hook有：

   • autoflake：移除所有未使用的导入，以及未使用的变量。

3. https://github.com/psf/black：black是一个Python代码格式化工具，它会自动把你的代码格式化为符合PEP 8风格的代码。配置中的hook有：

   • black：对python代码进行格式化。

4. https://github.com/pycqa/isort：isort是一个Python工具，可以对你的导入进行排序。配置中的hook有：

   • isort：对python代码的导入进行排序。

5. https://github.com/pycqa/flake8：flake8是一个Python工具，它集成了pylint, pyflakes, pycodestyle等多个代码检查工具，可以对你的代码进行风格检查，错误检查等。配置中的hook有：

   • flake8：对python代码进行风格检查，错误检查。

6. https://github.com/alessandrojcm/commitlint-pre-commit-hook：这个库提供了一个commitlint的pre-commit hook，用于检查你的commit message是否符合一定的规范。配置中的hook有：

   • commitlint：对commit message进行规范性检查。

7. https://github.com/charliermarsh/ruff-pre-commit：这个库提供了一个ruff的pre-commit hook，其可以执行一些特定的代码检查。配置中的hook有：

   • ruff：执行一些特定的代码检查。

8. https://github.com/Yelp/detect-secrets : 这个库提供了一个检查代码中是否包含账密的hook，可以在一定程度上避免开发人员把一些重要的账密提交到代码仓库中。

   • detect-secrets : 执行账密检查，除了支持默认的账密pattern，还支持自定义的pattern

这些hooks可以让你在提交代码之前就能发现并修复许多常见的问题，从而提高代码质量，节省Code Review的时间。