钩子之前就是Git的秘密武器 - pre-commit钩子

2024-01-10 12:54:18

我们天天都在使用的Git，却不了解Git这个工具，就好像一个天天在使用iPhone的人却对苹果产品一无所知。Git能成为这么一款成功的版本控制系统，除了它本身十分强悍以外，得益于Git这个平台为开发者提供了十分灵活的自定义能力。

正因为Git的这种可定制性，我们才能用他来完成各种天马行空的工具，因此衍生出了众多的辅助工具，其中最常用的一个就是pre-commit钩子，它是做什么用的呢？字面意思是"pre-commit"，顾名思义它就是在"commit"之前干点什么。

既然是"pre-commit"，那我们就有必要来聊聊commit。commit翻译过来就是提交的意思。在Git中，commit是一个非常重要的操作，它相当于给你做了一个"书签"，记录下来了当前代码的状态，以便于以后可以回退。

那么既然我们知道commit是一个很重要的事情，那么有没有必要在commit之前做点事情呢？当然有，pre-commit钩子最大的一个用处就是可以在提交代码之前对其进行检查，以确保代码符合一些规范。比如可以检查代码的格式是否正确，有没有潜在的错误，有没有不符合规范的地方等等。

如果检查发现不符合规范的地方，可以提示开发者修复这些问题，或者直接禁止提交。这样就可以在很大程度上提高代码的质量，并保持代码库的一致性。

pre-commit钩子的使用方法

在了解了pre-commit钩子的用途之后，接下来我们来看看怎么使用它。

pre-commit钩子其实是一个脚本文件，它放在.git/hooks目录下，名字是pre-commit。当我们执行git commit命令时，Git就会自动执行这个脚本文件。

我们可以使用任何脚本语言来编写pre-commit钩子，比如shell、Python、Ruby等等。但最常用的还是shell脚本。

下面是一个简单的pre-commit钩子脚本示例：

#!/bin/bash

# 检查代码格式是否正确
if ! git diff --cached --check | grep '^[+-]' | grep -q '^\s*[^/]' > /dev/null; then
  echo "代码格式不正确，请先修复格式错误再提交。"
  exit 1
fi

# 检查代码中有没有潜在的错误
if ! git diff --cached --check | grep -q '^[+-]\s*[a-zA-Z0-9_]\{2,}\s*=' > /dev/null; then
  echo "代码中存在潜在的错误，请先修复错误再提交。"
  exit 1
fi

# 检查代码中有没有不符合规范的地方
if ! git diff --cached --check | grep -q '^[+-]\s*[a-zA-Z0-9_]\{2,}\s*:' > /dev/null; then
  echo "代码中存在不符合规范的地方，请先修复规范错误再提交。"
  exit 1
fi