讲师中心 微信公众号
AI工具推荐 视频效率加速

Git怎么设置pre-commit钩子_Git如何在提交前自动运行代码检查【实战】

星婷君_1530

星婷君_1530

发布时间:2026-03-25 13:17:01

|

695人浏览过

|

来源于php中文网

原创

pre-commit 钩子必须放在 .git/hooks/pre-commit 路径且无后缀、有执行权限;需用 git diff --cached 精准过滤待提交的 JS/TS 文件,配合 npx eslint 检查并确保失败时退出码为 1;推荐用 npm prepare 软链复用脚本。

git怎么设置pre-commit钩子_git如何在提交前自动运行代码检查【实战】

pre-commit 钩子文件放哪才生效

Git 只认 .git/hooks/pre-commit 这个路径的可执行文件,其他位置(比如项目根目录下的 pre-commit 或 scripts/pre-commit)默认不会触发。

常见错误是把脚本放在别处、加了 .sh 后缀、或没给执行权限——Git 会静默跳过,不报错也不运行。

  • 进项目根目录,执行 chmod +x .git/hooks/pre-commit
  • 确保文件没有后缀(必须叫 pre-commit,不是 pre-commit.sh)
  • 如果用 #!/usr/bin/env bash 开头,确认系统有 bash 且路径正确(macOS 默认 /bin/bash,新版可能受限)
  • Windows 用户注意:WSL 下用 Linux 路径规则;Git for Windows 自带 Bash,但要用 #!/bin/sh 更稳妥

用 shell 脚本调用 ESLint / Prettier 最简写法

不用装额外工具链,纯 shell 就能跑检查。关键是捕获「本次提交要提交的 JS 文件」,而不是扫全量目录。

Git 提供 git diff --cached --name-only --diff-filter=ACM 来列出即将提交的新增/修改/重命名文件,过滤出 .js 和 .ts 即可。

  • 在 .git/hooks/pre-commit 里写:
#!/bin/sh
FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.js$\|\.ts$')
if [ -n "$FILES" ]; then
  npx eslint --quiet $FILES
  if [ $? -ne 0 ]; then
    echo "ESLint 失败,请修复后再提交"
    exit 1
  fi
fi
  • --quiet 避免输出大量警告干扰判断;真正阻断提交的是非零退出码
  • 别用 eslint . —— 会检查 node_modules 和历史文件,慢且误报多
  • 如果项目没装 eslint 到本地 node_modules,npx 会 fallback 到全局,但行为不稳定,建议统一用 npm exec eslint(npm v7+)

pre-commit 退出码为 1 却没拦住提交?

最常踩的坑:脚本里某条命令失败,但没被检测到,整体仍返回 0。

github-skill-manager
github-skill-manager

管理GitHub仓库中的技能,优先用于安装、检查更新、更新、卸载技能,或提及注册技能、GitHub技能、REGISTRY.yaml时。

下载

比如写了 eslint file.js; echo "done",即使 ESLint 报错,echo 成功导致整个脚本退出码是 0,Git 就当通过了。

  • 每条关键检查后加 || exit 1,或开头加 set -e(但注意它对管道和条件语句有陷阱)
  • 避免无意义的 echo、printf 放在检查逻辑后面,它们会覆盖前一条命令的退出码
  • 调试时在脚本末尾加 echo "exit code: $?",提交前手动运行 .git/hooks/pre-commit 看输出
  • Git 不捕获 stdout/stderr,所以日志得靠 echo 打到终端,否则你根本不知道它跑没跑

想让团队共用 pre-commit,又不想手动复制文件

直接硬拷贝 pre-commit 到每个人 .git/hooks/ 下,协作成本高、易不同步、还可能被 IDE 自动删掉(比如 VS Code 的 Git 插件)。

更稳的方式是用 npm prepare 脚本自动软链,或借助 husky 这类工具——但它底层仍是生成并 chmod 那个文件,只是帮你省了手动手续。

  • 推荐轻量方案:在 package.json 里加
"scripts": {
  "prepare": "ln -sf ../../scripts/pre-commit .git/hooks/pre-commit || cp scripts/pre-commit .git/hooks/"
}
  • 运行 npm install 后自动部署钩子;Windows 用户用 cp 分支兜底
  • 把真实脚本放在 scripts/pre-commit,方便 git commit、code review、CI 复用逻辑
  • 别把 .git/hooks/ 加进版本库——Git 不跟踪这个目录,而且不同用户钩子可能需微调(比如本地路径)

钩子本质是本地脚本,再怎么封装也绕不开「每个开发者机器上得有对应依赖」这一层。Node 版本、全局工具、甚至 shell 类型(zsh/bash),都可能让同一份脚本表现不一。

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2095

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3142

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1056

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

3579

2025.09.10

printf用法大全
printf用法大全

php中文网为大家提供printf用法大全,以及其他printf函数的相关文章、相关下载资源以及各种相关课程,供大家免费下载体验。

748

2023.06.20

fprintf和printf的区别
fprintf和printf的区别

fprintf和printf的区别在于输出的目标不同,printf输出到标准输出流,而fprintf输出到指定的文件流。根据需要选择合适的函数来进行输出操作。更多关于fprintf和printf的相关文章详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1009

2023.11.28

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

4236

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1315

2023.07.28

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn