0

0

VSCode + Git Hooks:在代码提交前自动运行检查

P粉986688829

P粉986688829

发布时间:2025-12-25 14:06:08

|

344人浏览过

|

来源于php中文网

原创

推荐使用 Husky 管理 Git Hooks,在 package.json 中声明式配置 pre-commit 钩子执行 lint-staged 等检查;VSCode 通过 ESLint 等插件实时提示错误,确保本地与 CI 检查一致;跳过需谨慎,仅限 WIP 等明确场景。

vscode + git hooks:在代码提交前自动运行检查

在代码提交前自动运行检查,关键在于用 Git Hooks 拦截 git commit 流程,并在其中执行检查命令(如 ESLint、Prettier、TypeScript 编译等),VSCode 本身不直接管理 hooks,但能无缝配合本地配置,让开发体验更顺滑。

用 Husky 管理 Git Hooks(推荐)

Husky 是目前最主流的 Git Hooks 管理工具,它把钩子脚本声明式地写在 package.json 中,避免手动维护 .git/hooks/ 下的文件,也支持跨团队同步。

  • 安装:运行 npm install husky --save-dev
  • 启用:执行 npx husky install(会创建 .husky/ 目录并设置 Git 的 hooks path)
  • 添加 pre-commit 钩子:运行 npx husky add .husky/pre-commit "npm run lint-staged"
  • 搭配 lint-staged 只检查暂存区文件,更快更精准

VSCode 配合:让编辑器“感知”检查结果

VSCode 不会自动触发 Git Hooks,但它能通过插件或配置,提前暴露潜在问题,减少被 hook 拦下的次数。

  • 安装 ESLint、Prettier、TypeScript 插件,开启 "editor.codeActionsOnSave": { "source.fixAll": true }
  • settings.json 中设 "eslint.run": "onType""onSave",实时提示错误
  • 确保项目根目录有 .eslintrc.cjs.prettierrc 等配置,VSCode 插件才能正确读取规则

本地检查和 CI 保持一致

别让本地能过、CI 失败。把检查命令统一定义在 package.json#scripts 里,Git Hook 和 CI 都调用同一脚本。

迅易年度企业管理系统开源完整版
迅易年度企业管理系统开源完整版

系统功能强大、操作便捷并具有高度延续开发的内容与知识管理系统,并可集合系统强大的新闻、产品、下载、人才、留言、搜索引擎优化、等功能模块,为企业部门提供一个简单、易用、开放、可扩展的企业信息门户平台或电子商务运行平台。开发人员为脆弱页面专门设计了防刷新系统,自动阻止恶意访问和攻击;安全检查应用于每一处代码中,每个提交到系统查询语句中的变量都经过过滤,可自动屏蔽恶意攻击代码,从而全面防止SQL注入攻击

下载
  • 例如:"scripts": { "lint": "eslint src/", "format": "prettier --write .", "check": "npm run lint && npm run type-check" }
  • Husky 的 pre-commit 调用 npm run check,CI 的 job 也跑这个命令
  • type-check 脚本(如 tsc --noEmit)可提前发现类型错误

跳过钩子要谨慎,但得留出口

偶尔需要绕过检查(比如写一半的 WIP 提交),可以用 git commit --no-verify 或简写 -n。但建议:

  • 在团队文档中明确哪些情况允许跳过
  • 避免在主分支相关分支上跳过 lint / test
  • 考虑用 git commit -m "chore: wip" --no-verify 加注释,提醒自己补检查

基本上就这些。核心是:Husky 拦住提交、VSCode 提前报错、脚本统一维护、跳过机制可控。不复杂但容易忽略细节,配好一次,后续所有提交都自动受保护。

相关专题

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

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

400

2023.08.07

json是什么
json是什么

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

528

2023.08.23

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

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

305

2023.10.13

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

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

67

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

424

2024.06.27

自建git服务器
自建git服务器

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

635

2023.07.05

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

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

523

2023.07.06

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.5万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 7.2万人学习

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

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号