VSCode如何配置husky预提交钩子_VSCode husky预提交钩子配置解析

如何让 pre-commit 只处理暂存区文件，而不是整个项目

直接写npx prettier --write .这种命令是有点“莽”的。它会格式化整个项目目录下的文件，速度慢不说，还可能误伤node_modules或者一些自动生成的代码。正确的思路是：只对已经通过git add放入暂存区的文件进行操作。

这里推荐两种比较稳妥的做法：

• 使用 lint-staged（主流选择）：先在package.json里配置好"lint-staged"字段，然后pre-commit脚本里只需要简单写一句npx lint-staged就行了。它会自动调用git diff --cached来提取暂存区的文件列表，非常省心。
• 手动过滤（适合轻量级项目）：如果你不想引入额外依赖，可以在.husky/pre-commit里手动写命令。例如：npx prettier --write $(git diff --cached --name-only --diff-filter=ACM | grep -E '\.(js|ts|json)$')。这里有个细节：--diff-filter=ACM参数确保了只筛选出新增（A）、修改（C）和重命名（M）的文件，避开了已删除的文件，从而避免操作报错。

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

这种情况属于典型的“配置错位”。需要明确一个概念：提交消息模板是由Git自身管理的，跟Husky的commit-msg钩子没有直接关系。VSCode源代码管理面板能不能加载出模板，完全取决于git config commit.template这个配置项是否指向了一个有效的文件路径。

遇到不显示模板的问题，可以按下面几步检查和修复：

• 运行git config --get commit.template，看看它返回的路径是不是你项目里真实存在的文件（比如.gitmessage.txt）。
• 如果路径没错，但VSCode还是不显示，那可能是文件本身的编码问题。确保你的.gitmessage.txt是UTF-8无BOM格式，并且文件末尾有一个空行（这是Git的一个要求）。
• 至于commit-msg钩子，它只负责校验提交消息的格式（比如是否符合约定式提交规范）。校验失败时，VSCode会弹出错误提示。但模板的渲染和展示，完全是Git和VSCode集成逻辑的工作，Husky并不参与这个过程。

为什么 pre-commit 后代码没自动 git add？

这是一个非常容易踩坑的细节。原因很简单：Husky默认不会帮你把格式化后的文件重新加回暂存区。举个例子，prettier --write命令确实修改了文件内容，但在Git看来，这些修改仍然处于“已修改但未暂存”的状态。如果你直接提交，这些格式化的变更并不会被包含进去——结果就是，代码确实被格式化了，但提交记录里却看不到。

怎么解决呢？方案分两层：

• 如果使用 lint-staged：需要在它的配置里显式地加上"git add"这一步。例如："*.{js,ts}": ["eslint --fix", "prettier --write", "git add"]。这样在格式化完成后，它会自动将变更重新暂存。
• 如果手写脚本：可以在prettier命令后面追加&& git add .。但要注意，这样会把工作区所有修改都暂存，不够精确。更稳妥的做法是：&& git add $(git diff --name-only --cached)，这只重新添加那些原本就在暂存区、并且刚刚被格式化工具修改过的文件。

最后再强调一下这个核心逻辑：VSCode的提交界面，只会提交当前暂存区里的内容。它不会自动去扫描并包含那些你刚格式化完、但忘记执行git add的文件。把这个流程理顺，预提交钩子的配置才算真正到位。