排查Git提交前代码检查失效
许多开发者使用pre-commit库在提交代码前执行代码风格检查和lint检查，确保代码质量一致性。但有时pre-commit钩子无法触发，导致代码检查失效。本文分析一个案例，并提供解决方案。
问题：
用户配置了pre-commit库，在package.json中定义了pre-commit字段，期望提交前执行echo和check脚本，但实际提交时脚本未执行。package.json内容如下：
{
"name": "test",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"check": "node ./config/check.js",
"echo": "echo \"Error: I SHOULD FAIL LOLOLOLOLOL \" && exit 1"
},
"pre-commit": ["echo", "check"],
"author": "",
"license": "ISC",
"dependencies": {
"@svgdotjs/svg.draggable.js": "^3.0.3",
"@svgdotjs/svg.js": "^3.2.0"
},
"devDependencies": {
"pre-commit": "^1.2.2"
}
}
原因及解决方案：
问题在于，虽然package.json声明了pre-commit字段，但未安装或未正确配置pre-commit库。pre-commit字段仅声明要执行的脚本，并非自动执行工具。需要额外安装和配置pre-commit。
正确步骤：
-
全局安装pre-commit: 使用
npm install -g pre-commit(或yarn global add pre-commit)全局安装pre-commit，确保命令可用。 -
安装项目依赖: 使用
npm install(或yarn)安装项目依赖，包括package.json中列出的pre-commit依赖。 -
初始化pre-commit: 在项目根目录运行
pre-commit install，安装pre-commit钩子到Git仓库。 -
验证配置: 尝试提交代码，检查
echo和check脚本是否执行。如果仍未执行，检查./config/check.js是否存在且具有执行权限，以及脚本是否正确。确保脚本正确执行并返回非零退出码以触发提交失败。
如果问题依然存在，检查npm或yarn配置，以及shell环境变量设置。
