如果想要在提交之前运行代码性检查工具，并在测试失败时阻止提交，该怎样配置 Git 存储库？

**完整性检查**（或称冒烟测试）是一种基本的测试方法，用于确定继续测试或提交代码是否合理和可行。它确保在进行更深入的测试之前，代码至少通过了一些基本的标准，如代码格式、语法检查等。 ### 如何在提交之前运行代码性检查工具并阻止失败的提交？ 要在Git存储库中实现提交前的代码性检查，可以使用 **pre-commit hook**。Git提供了钩子（hooks）机制，在特定事件发生时自动执行脚本。`pre-commit` hook 是在你运行 `git commit` 命令之前触发的，它可以用来执行一系列的检查，比如代码格式化、linting等。如果这些检查失败，提交过程将被阻止。 ### 实现步骤： 1. **创建或编辑 pre-commit hook**： - Git hooks 位于 `.git/hooks/` 目录中。`pre-commit` hook 的默认文件名是 `pre-commit.sample`。你可以将它重命名为 `pre-commit`，或者创建一个新的文件 `pre-commit`。 2. **编写钩子脚本**： - 在 `pre-commit` 文件中编写脚本来执行代码检查工具。例如，你可以使用 linters 来检查代码质量，或者使用格式化工具来确保代码符合规范。 3. **示例脚本**： - 以下是一个简单的 `pre-commit` 脚本示例，它检查所有即将提交的 `.go` 文件是否通过了 `gofmt`（Go语言的代码格式化工具）的检查。如果有任何文件未通过格式化检查，脚本将阻止提交： ```bash #!/bin/sh # Redirect output to stderr exec 1>&2 # Check all staged .go files for file in $(git diff --cached --name-only --diff-filter=ACM | grep '\.go$') do # Run gofmt on the file gofmt -l "$file" if [ $? -ne 0 ]; then echo "Error: $file is not formatted correctly." exit 1 fi done # If the script reaches here, it means all files are formatted correctly ``` - **解释**： - `git diff --cached --name-only --diff-filter=ACM`：获取所有被暂存（staged）准备提交的文件列表，并筛选出新增（A）、复制（C）或修改（M）的文件。 - `grep '\.go$'`：只匹配 `.go` 文件。 - `gofmt -l "$file"`：检查文件是否符合Go的格式规范。如果不符合，`gofmt` 会返回一个非零状态码，并且脚本会输出错误消息并阻止提交。 4. **使脚本可执行**： - 确保脚本具有可执行权限： ```bash chmod +x .git/hooks/pre-commit ``` 5. **提交时的效果**： - 现在，每次你运行 `git commit` 时，Git都会先执行 `pre-commit` hook。只有当所有检查通过时，提交才会成功。如果任何检查失败，Git 将显示错误信息并阻止提交。 ### 总结 通过使用 Git 的 `pre-commit` hook，你可以在提交之前运行代码性检查工具，并在检查失败时阻止提交。这可以确保团队中的每个开发者在提交代码时都遵循相同的代码质量标准，减少了代码库中的问题，并提高了整体的代码质量。上述示例展示了如何使用 `gofmt` 对 Go 代码进行格式检查，你可以根据需要替换或扩展此脚本以适应其他语言和工具。