VSCode配置Husky代码提交规范 Git钩子自动化教程【指南】

夜磊同学_9984

夜磊同学_9984

2026-06-11

784人浏览

原创

lint-staged是核心工具,husky仅执行命令;pre-commit应写npx lint-staged,因其自动提取暂存文件、按后缀分发任务、自动git add,避免误操作与格式不一致。

vscode配置husky代码提交规范 git钩子自动化教程【指南】

Husky 本身不格式化、不校验、不写入 Git 暂存区——它只负责在 git commit 触发时,忠实地执行你写的那行命令。真正干活的是 lint-staged、prettier 或 eslint,而 VSCode 只管保存时的即时反馈。

pre-commit 钩子该写什么命令?别直接调用 prettier --write .

写 npx lint-staged 是最稳的选择,不是因为“高级”,而是它天然解决三个硬伤:

  • lint-staged 自动从 git diff --cached 提取暂存文件,不会误扫 node_modules 或未 git add 的草稿
  • 支持按后缀分发不同命令(比如 JS 跑 eslint --fix + prettier --write,CSS 只跑 prettier --write)
  • 格式化后自动 git add 回暂存区——这点必须有,否则改了文件但没加进提交,husky 会报错退出

如果你跳过 lint-staged 直接写 npx prettier --write .,大概率会卡在权限错误、路径不存在,或把生成文件/配置文件一并重写。

为什么 pre-commit 看似运行了,但代码没被格式化?

常见断点不在 husky,而在下游工具链是否“连得通”:

YiHui GITHUB MONITOR
YiHui GITHUB MONITOR

监控多个 GitHub 仓库,配置发布、PR 与安全告警策略,通过定时 cron 任务推送低噪声通知。

下载
  • .husky/pre-commit 文件缺少可执行权限(Linux/macOS 下必须 chmod +x .husky/pre-commit)
  • package.json 里 lint-staged 字段的 glob 模式和你 git add 的文件不匹配(例如写了 *.js 却提交了 index.tsx)
  • prettier 找不到 .prettierrc,退回到默认规则——这时 VSCode 看到的和 husky 执行的格式结果可能不一致
  • npx 在 VSCode 内置终端里找不到本地 node_modules/.bin/prettier(PATH 不一致),建议在 .husky/pre-commit 开头加 echo $PATH 对比验证

VSCode 保存格式化和 husky 提交前格式化能共存吗?

能,而且应该共存,但前提是规则完全对齐:

  • VSCode 保存时用 editor.formatOnSave: true 快速响应,靠 esbenp.prettier-vscode 插件读取项目根目录的 .prettierrc
  • husky + lint-staged 是兜底:处理你忘了保存的文件、修复 VSCode 插件没覆盖的规则(比如 ESLint 的 no-console)、阻断不合规提交
  • 关键:所有配置文件(.prettierrc、.eslintrc.js、.stylelintrc.json)必须放在项目根目录,并且 git add 进仓库——VSCode 和 husky 都依赖这个路径读取,不存在“本地插件读一个、npx 读另一个”的情况

VSCode 提交面板不显示模板,但 commit-msg 钩子却生效?

这是典型混淆:VSCode 是否显示提交模板,和 husky 完全无关。

  • 模板由 Git 原生命令控制:git config --get commit.template 返回的路径是否有效、是否 UTF-8 无 BOM、末尾是否有空行
  • commit-msg 钩子是 husky 注册的另一套逻辑,只在校验提交信息格式(比如是否以 feat: 开头),它不参与模板渲染
  • 如果 VSCode 没加载模板,先检查 .gitmessage.txt 是否存在且编码正确,而不是去翻 .husky/commit-msg

最容易被忽略的其实是环境一致性:VSCode 终端、系统终端、CI 环境下的 Node 版本、npx 查找路径、Prettier 配置加载顺序,稍有偏差就导致“本地 OK,提交失败”。与其反复调试,不如在 .husky/pre-commit 开头固定写上 set -euxo pipefail,让每一步失败都暴露出来。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

6319

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

1820

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

1074

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4117

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

3861

6

vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1375

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2912

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1989

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1727

8

热门下载

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

精品课程

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