git add钩子文件

1. 什么是git add钩子

在使用Git进行版本控制时，我们经常会使用 git add 命令将修改的文件添加到暂存区。git add 钩子（Git add hook）可以在执行 git add 命令时自动触发，并且可以通过配置钩子脚本来进行一些自定义的操作。

钩子是一种在特定事件发生时自动触发的脚本，可以用来实现一些特定的操作。Git中有多个不同的钩子，其中包括 pre-commit 钩子、post-commit 钩子以及我们要介绍的 pre-add 钩子。

2. `pre-add` 钩子的作用

pre-add 钩子会在执行 git add 命令之前自动触发，因此可以用来在将文件添加到暂存区之前进行一些额外的操作和校验，比如格式检查、代码风格规范检查、代码质量检查等。

通过使用 pre-add 钩子，我们可以在开发过程中对代码进行自动化检查和验证，避免低级错误和不规范的代码提交到版本库中，提高团队协作的效率和代码的质量。

3. 创建 `pre-add` 钩子

要创建 pre-add 钩子，我们需要在 .git/hooks 目录下创建一个名为 pre-add 的可执行文件。可以使用任意脚本语言编写钩子，在本文中我们以 Bash 脚本为例进行说明。

首先，打开终端并进入到 Git 仓库的根目录，然后执行以下命令创建 pre-add 钩子：

cd .git/hooks
touch pre-add
chmod +x pre-add

上述命令通过 touch 创建了一个名为 pre-add 的文件，并通过 chmod 命令添加可执行权限。

4. 编写 `pre-add` 钩子脚本

接下来，我们打开 pre-add 文件，并编辑钩子脚本。

#!/bin/bash

# 提示用户添加的文件不符合要求
echo "Error: You are trying to add invalid files."
exit 1

上述脚本简单地输出了一条错误提示信息，并使用 exit 1 终止了 git add 命令的执行。

当我们执行 git add 命令时，如果添加的文件不符合要求，将会触发 pre-add 钩子并显示错误消息。

5. 测试 `pre-add` 钩子

为了测试 pre-add 钩子，我们可以在Git仓库中添加一些需要检查的文件，然后执行 git add 命令。

touch test.txt
git add test.txt

运行上述命令后，我们可以看到输出的错误消息：

Error: You are trying to add invalid files.

这表明 pre-add 钩子脚本起作用了，成功阻止了添加不符合要求的文件。

6. 实际应用场景

pre-add 钩子可以应用于许多实际的场景中，以下是一些常见的应用示例：

6.1 代码格式检查

在团队开发中，为了保持代码的统一风格，通常会使用代码格式化工具，如 Prettier、ESLint 等。可以将代码格式检查与 pre-add 钩子集成，以确保不符合统一风格的代码无法添加到暂存区。下面是一个示例：

#!/bin/bash

files= $(git diff --name-only --cached) errors=() for file in$ files; do
  if [[  $file == *".js" ]]; then if ! eslint "$ file"; then
      errors+=(" $file") fi fi done if [[$ {#errors[@]} -gt 0 ]]; then
  echo "Error: The following files have formatting errors:"
  for error in " ${errors[@]}"; do echo " -$ error"
  done
  exit 1
fi

上述脚本中，我们使用eslint命令检查所有.js文件是否符合规范，如果有任何错误，则阻止 git add 命令执行。

6.2 敏感信息检查

在提交代码时，可能会不小心将敏感信息（如密码、API密钥等）提交到版本库。可以通过 pre-add 钩子脚本进行敏感信息检查，以避免泄露敏感信息。以下是一个示例：

#!/bin/bash

files= $(git diff --name-only --cached) errors=() for file in$ files; do
  if grep -qE "password|api_key" " $file"; then errors+=("$ file")
  fi
done

if [[  ${#errors[@]} -gt 0 ]]; then echo "Error: The following files contain sensitive information:" for error in "$ {errors[@]}"; do
    echo " - $error"
  done
  exit 1
fi

上述脚本中，我们使用 grep 命令在要添加到暂存区的文件中搜索敏感信息的关键词，如果检测到敏感信息，则阻止 git add 命令执行。