如何编写一个Git Hook？

Git Hook 是 Git 提供的一种机制，允许你在特定的时间点触发自定义脚本。这些脚本可以用来检查代码、设置环境，或者执行任何你需要在 Git 工作流中自动完成的任务。Git Hook 脚本位于 Git 仓库的 .git/hooks 目录下，这个目录包含了一些示例脚本，你可以根据需要修改这些脚本。

以下是一个简单的步骤，指导你如何编写一个 Git Hook，特别是针对前端开发的 pre-commit Hook，该 Hook 在每次提交之前运行，可以用来检查代码是否符合某些标准。

步骤 1: 进入你的 Git 仓库

首先，打开终端，并导航到你的 Git 仓库所在的目录。

cd path/to/your/repository

步骤 2: 设置 Hook 脚本

进入 .git/hooks 目录，并查看示例 Hook 脚本。

cd .git/hooks
ls -l

你会看到一系列以 .sample 结尾的文件。这些文件是 Git 提供的示例 Hook 脚本。为了创建一个 pre-commit Hook，你可以复制 pre-commit.sample 文件并重命名为 pre-commit，或者直接创建一个新的 pre-commit 文件。

cp pre-commit.sample pre-commit
# 或者
touch pre-commit

然后，使用你喜欢的文本编辑器打开 pre-commit 文件。

nano pre-commit  # 或者使用 vim, emacs, code 等编辑器

步骤 3: 编写 Hook 逻辑

在 pre-commit 文件中，你可以编写任何你希望在提交之前执行的逻辑。以下是一个简单的示例，该示例使用 ESLint 检查 JavaScript 代码的风格和一致性。

#!/bin/sh
#
# 这是一个 pre-commit Hook 示例，用于在提交之前运行 ESLint 检查 JavaScript 代码。
#

# 检查是否有未暂存的更改，如果有，则提醒用户并退出。
if git diff --cached --quiet; then
    # 没有未暂存的更改，继续执行 ESLint 检查。
    echo "Running ESLint..."
    node_modules/.bin/eslint --ext .js,.jsx,.ts,.tsx src/
    if [ $? -ne 0 ]; then
        echo "ESLint 检查失败，请修复代码风格问题后再提交。"
        exit 1  # 退出并返回错误码，这将阻止提交。
    fi
else
    # 有未暂存的更改，提醒用户并退出。
    echo "你有未暂存的更改，请先暂存所有更改，然后再提交。"
    exit 1  # 退出并返回错误码，这将阻止提交。
fi

注意：这个示例假设你已经安装了 ESLint，并且将其配置为检查 src/ 目录下的 JavaScript 文件。你需要根据你的项目结构和工具链进行相应的调整。

步骤 4: 保存并设置可执行权限

保存 pre-commit 文件，并确保它具有可执行权限。

chmod +x pre-commit

步骤 5: 测试你的 Hook

现在，每当你尝试提交更改时，Git 都会运行你的 pre-commit Hook 脚本。你可以通过修改一些代码并尝试提交来测试它是否按预期工作。

如果 Hook 脚本返回非零退出码（例如，在上面的示例中，如果 ESLint 检查失败），则提交将被中止，并且你将看到相应的错误消息。如果 Hook 脚本成功执行并返回零退出码，则提交将继续进行。