如何使用 git 的 hook 来验证代码规范

在开发过程中，使用 Git 的 Hook 来验证代码规范是一种提高代码质量的有效方法。Git Hook 是 Git 的一项功能，允许在执行特定的Git操作（如提交和推送）时触发自定义脚本。使用这些钩子（Hooks），可以在代码提交到仓库之前、检查代码是否符合项目的编码规范、执行单元测试、以及运行代码检查工具如ESLint、Prettier 或 Stylelint。

例如，我们可以部署一个 pre-commit Hook，在开发者执行 git commit 命令时激活。这个钩子会运行一个脚本，检查待提交的代码是否遵循项目规范。如果不符合，它会拒绝提交并提供反馈，指出需要修正的问题。通过这种方式，团队能确保只有符合规范的代码才能被提交到版本控制系统中。

一、创建并配置 Git Hook

要使用 Git Hook 验证代码规范，首先需要在 Git 项目的 .git/hooks 目录下创建钩子脚本。每一个 Git 项目都含有这个目录，里面包含若干样本脚本。对于代码规范检查，最常用的钩子是 pre-commit。

创建钩子脚本，首先需要复制样本文件 pre-commit.sample，移除 .sample 扩展名，使其成为一个可执行脚本 pre-commit。然后在这个脚本中添加需要执行的代码检查命令。例如，以下是一个简单的脚本，它使用 ESLint 检查 JavaScript 文件：

#!/bin/sh

files=$(git diff --cached --name-only --diff-filter=ACM | grep '\.js$')
if [ "$files" ]; then
  npm run lint $files
fi

在这个例子中，脚本首先找出所有准备提交的 JavaScript 文件，然后执行 npm run lint 命令来对这些文件进行 ESLint 检查。如果检查未通过，则脚本退出并返回非零状态，导致提交被终止。

二、配置代码检查工具

在Git Hook脚本中要运行代码检查工具，首先需要在项目中正确配置这些工具。例如，若使用 ESLint，你需要在项目的根目录下创建一个 .eslintrc 配置文件。此配置文件应该包含关于代码规则的设置，以及可能需要的插件和解析器选项。

配置文件内容可能如下：

{

  "extends": "eslint:recommended",
  "rules": {
    "indent": ["error", 2],
    "linebreak-style": ["error", "unix"],
    "quotes": ["error", "single"]
  }
}

配置文件定义了代码应该使用两个空格缩进、UNIX换行符、以及单引号。当运行 ESLint 检查时，它将根据这些规则来评估代码。

三、自动化安装 Git Hook

为了确保所有团队成员都使用相同的 Hook 脚本，最佳实践是通过自动化的方式安装 Git Hook。一个常见的方式是使用 husky 包，这是一个在 Node.js 项目中添加 Git Hook 的工具。通过将 Husky 添加为依赖，可以确保项目克隆或依赖安装时自动配置 Git Hooks。

以下是使用Husky设置 pre-commit Hook的步骤:

1. 安装 Husky 作为开发依赖：

npm install husky --save-dev

2. 在项目的package.json 文件中，添加一个 husky 字段，配置pre-commit 钩子：

"husky": {

  "hooks": {
    "pre-commit": "npm run lint"
  }
}

3. 在 package.json 中添加一个 lint 脚本：

"scripts": {

  "lint": "eslint ."
}

当完成以上步骤后，每次执行 git commit 命令之前，Husky 将自动执行 npm run lint，运行 ESLint 在所有代码文件上。

四、处理 Hook 拒绝的提交

有时，开发者可能需要临时绕过 Hook。例如，当他们想要提交一个尚未完全符合代码规范的工作进度。为此，Git 提供了一个选项 --no-verify，可以用于 git commit 命令，以绕过 pre-commit 钩子。

git commit --no-verify -m "WIP: Work in progress"

当使用这个选项时，需要谨慎，因为它会绕过所有的代码检查。通常建议在紧急情况下，或者当你完全了解可能的后果时，才使用这个选项。

五、维护 Git Hook 脚本

随着项目的发展，可能需要更新和维护 Git Hook脚本。这可能是由于更改代码规范、添加新的检查工具或者是优化现有脚本。定期检查和测试这些脚本非常重要，以确保它们仍然有效且符合项目需要。

维护Hook脚本应确保以下点：

• 脚本与项目中使用的代码检查工具的版本兼容。
• 脚本能够正确地过滤出应该检查的文件。
• 脚本能够提供清晰、有用的反馈，帮助开发者理解代码规范违规。

结论

在保证代码质量方面，使用 Git Hook 来验证代码规范是一种非常有效的方法。通过在开发流程中自动化执行代码检查和测试，可以确保只有符合标准的代码才被集成到项目中。尽管需要一定的初始设置和维护，但长远来看，这能大幅提升代码质量并减少潜在的错误和技术债务。

相关问答FAQs：

1. 为什么需要使用 Git的hook来验证代码规范？

验证代码规范是保持代码质量高、易于维护和合作的重要步骤之一。使用Git的hook可以在代码提交之前自动化地进行代码规范的检查，避免了手动检查的繁琐和容易遗漏的问题，提高了开发效率。

2. 如何为项目设置Git的hook来验证代码规范？

设置Git的hook非常简单。首先，在项目的.git文件夹下找到hooks文件夹，其中包含了一系列用于自定义Git行为的脚本文件。选择合适的脚本文件，例如pre-commit脚本，在其中添加用于验证代码规范的命令或脚本。可以使用各种代码规范的检查工具，例如ESLint、Prettier、stylelint等，根据项目需求进行选择。确保脚本的执行权限正确设置，然后完成设置。

3. 如何使用Git的hook来验证代码规范？

使用Git的hook来验证代码规范非常简单。当我们进行代码提交时，Git会自动触发pre-commit钩子，执行我们在脚本中设定的代码规范检查命令。如果代码不符合规范，Git会拒绝我们的提交，并返回相应的错误信息。这样，我们就可以在代码提交前及时发现并修复代码规范问题，确保项目的代码质量。

总结：通过设置Git的hook并使用代码规范检查工具，我们可以在提交代码前自动验证代码的规范。这样可以提高代码质量，减少人为错误，更好地维护和合作项目。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。