仓库源文，站点原文

title: 在Git项目中增加pre-commit校验 toc: true cover: 'https://img.paulzzh.com/touhou/random?22' date: 2021-10-10 15:50:46 categories: 技术杂谈 tags: [技术杂谈, Git]

description: 有些编程语言提供了代码格式化检查等工具，如：Go、Rust等，我们可以在commit之前，对代码进行格式化检查，保证代码规范，而pre-commit正是这样的工具；

有些编程语言提供了代码格式化检查等工具，如：Go、Rust等，我们可以在commit之前，对代码进行格式化检查，保证代码规范，而pre-commit正是这样的工具；

<br/>

在Git项目中增加pre-commit校验

pre-commit 概述

pre-commit官方网站：

• https://pre-commit.com/

pre-commit支持的功能有：

• 只需要提供配置文件地址，自动从中央hooks仓库获取脚本（如果有多个项目，就不需要再每个项目都拷贝一份hooks了）；
• 可以定义本地脚本仓库，允许开发人员自定义脚本，且无需修改配置文件：
• 每个阶段允许定义多个脚本：
  • 多个脚本可以使得功能划分而无需整合到一个臃肿的文件中；
• 脚本支持多种语言

需要注意的是：pre-commit这个工具不仅仅可以在pre-commit阶段执行，其实可以在git-hooks的任意阶段；

<br/>

安装pre-commit

在系统中安装pre-commit

brew install pre-commit
# 或者
pip install pre-commit --user

# 查看版本
pre-commit --version

在项目中安装pre-commit

除了需要在系统中安装pre-commit，还需要在Git项目中安装：

cd <git-repo>
pre-commit install

# 卸载
pre-commit uninstall

上面的操作将会在项目的.git/hooks下生成一个pre-commit文件（覆盖原pre-commit文件），该hook会根据项目根目录下的.pre-commit-config.yaml执行任务；

如果vim .git/hooks/pre-commit可以看到代码的实现，基本逻辑是利用pre-commit文件去拓展更多的pre-commit；

安装/卸载其他阶段的hook：

pre-commit install
pre-commit uninstall
-t {pre-commit,pre-merge-commit,pre-push,prepare-commit-msg,commit-msg,post-checkout,post-commit,post-merge}
--hook-type {pre-commit,pre-merge-commit,pre-push,prepare-commit-msg,commit-msg,post-checkout,post-commit,post-merge}

# 如 pre-commit install --hook-type prepare-commit-msg

常用指令

# 手动对所有的文件执行hooks，新增hook的时候可以执行，使得代码均符合规范。直接执行该指令则无需等到pre-commit阶段再触发hooks
pre-commit run --all-files

# 执行特定hooks
pre-commit run <hook_id>

# 将所有的hook更新到最新的版本/tag
pre-commit autoupdate

# 指定更新repo
pre-commit autoupdate --repo https://github.com/DoneSpeak/gromithooks

更多指令及指令参数请直接访问pre-commit官方网站；

<br/>

添加第三方hooks

在Git仓库初始化pre-commit：

cd <git-repo>
pre-commit install
touch .pre-commit-config.yaml

如下为一个基本的配置样例：

.pre-commit-config.yaml

# 该config文件为该项目的pre-commit的配置文件，用于指定该项目可以执行的git hooks

# 这是pre-commit的全局配置之一，fail_fast：遇到错误不会向下执行直接退出
fail_fast: false 

repos:
# hook所在的仓库
- repo: https://github.com/pre-commit/pre-commit-hooks
  # 仓库的版本，可以直接用tag或者分支，但分支是容易发生变化的
  # 如果使用分支，则会在第一次安装之后不自动更新
  # 通过 `pre-commit autoupdate`指令可以将tag更新到默认分支的最新tag
  rev: v4.0.1
  # 仓库中的hook id
  hooks:
  # 定义的hook脚本，在repo的.pre-commit-hooks.yaml中定义
  - id: check-added-large-files
  # 移除尾部空格符
  - id: trailing-whitespace
    # 传入参数，不处理makedown
    args: [--markdown-linebreak-ext=md]
  # 检查是否含有合并冲突符号
  - id: check-merge-conflict

- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
  rev: v2.0.0
  hooks:
  - id: pretty-format-yaml
    # https://github.com/macisamuele/language-formatters-pre-commit-hooks/blob/v2.0.0/language_formatters_pre_commit_hooks/pretty_format_yaml.py
    # hook脚本需要的参数，可以在该hook脚本文件中看到
    args: [--autofix, --indent, '2']

上面我们引入了两个配置：

• https://github.com/pre-commit/pre-commit-hooks
• https://github.com/macisamuele/language-formatters-pre-commit-hooks

在run之后，pre-commit会下载指定仓库代码，并安装配置所需要的运行环境；

配置完成之后可以通过pre-commit run --all-files运行一下添加的hooks；

下表为.pre-commit-hooks.yaml可选配置项：

关于开发hooks仓库：

• 开发hooks仓库

<br/>

本地hooks

pre-commit 也提供了local的hook，允许在entry中配置执行指令或指向本地一个可执行的脚本文件，使用起来和husky类似；

• 脚本与代码仓库紧密耦合，并且与代码仓库一起分发；
• Hooks需要的状态只存在于代码仓库的build artifact中(比如应用程序的pylint的virtualenv)；
• linter的官方代码仓库没有提供pre-commit metadata；

local hooks可以使用支持additional_dependencies 的语言或者 docker_image / fail / pygrep / script / system；

在使用时，需要定义repo: local，即：本地仓库；

例如：

# 定义repo为local，表示该repo为本地仓库
- repo: local
  hooks:
  - id: pylint
    name: pylint
    entry: pylint
    language: system
    types: [python]
  - id: changelogs-rst
    name: changelogs must be rst
    entry: changelog filenames must end in .rst
    language: fail # fail 是一种用于通过文件名禁止文件的轻语言
    files: 'changelog/.*(?<!\.rst)$'

上面给hooks定义了两个步骤：

• pylint
• changelogs-rst

<br/>

几配置例子

Rust项目

https://github.com/JasonkayZK/rust-learn/blob/main/.pre-commit-config.yaml

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: check-merge-conflict
      - id: check-toml
      - id: check-yaml
      - id: end-of-file-fixer
      - id: trailing-whitespace
        args: [ --markdown-linebreak-ext=md ]

  - repo: local
    hooks:
      - id: cargo-fmt
        name: cargo fmt
        entry: cargo fmt --
        language: rust
        types: [ rust ]

<br/>

Go项目

https://github.com/JasonkayZK/Go_Learn/blob/master/.pre-commit-config.yaml

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: check-merge-conflict
      - id: check-yaml
      - id: end-of-file-fixer
      - id: trailing-whitespace
        args: [ --markdown-linebreak-ext=md ]

  - repo: local
    hooks:
      - id: go-fmt
        name: go fmt
        entry: gofmt -w -s --
        language: golang
        types: [ go ]
      - id: go-imports
        name: go imports
        entry: goimports --
        language: golang
        types: [ go ]

<br/>

附录

文章参考：

• Continuous Integration with Github Actions and Rust
• 在Git项目中使用pre-commit统一管理hooks