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

VSCode代码提交时自动检查代码规范方案

浅瑶酱_8665

浅瑶酱_8665

发布时间:2026-07-28 08:23:19

|

172人浏览过

|

来源于php中文网

原创

VSCode本身不执行提交检查,真正起作用的是husky + lint-staged + eslint/prettier组合;需确保husky初始化、lint-staged规则匹配暂存文件、所有工具本地安装且配置文件置于项目根目录,否则提交将静默跳过检查。

vscode代码提交时自动检查代码规范方案

直接上结论:VSCode 本身不执行提交检查,真正起作用的是 husky + lint-staged + eslint/prettier 这套组合。配置错一个环节,比如 husky 没初始化、lint-staged 规则没匹配到文件、或 ESLint 本地没装,提交就会静默跳过检查。

pre-commit hook 怎么触发 lint-staged

关键不是 VSCode 点“提交”按钮那一刻才运行,而是 Git 执行 git commit 命令时,由 Husky 拦截并调用 lint-staged。VSCode 的提交界面只是封装了这个命令。

  • npx husky install 必须在项目根目录运行,它会在 .husky/ 下生成钩子脚本
  • npx husky add .husky/pre-commit "npx lint-staged" 是把 lint-staged 命令写进 pre-commit 钩子——注意路径是 .husky/pre-commit,不是 .husky/pre-commit.sh 或其他变体
  • 如果项目用 pnpm,得确认 npx 能正确解析本地 bin;pnpm 用户建议改用 pnpx lint-staged
  • 验证是否生效:终端里手动跑 git commit --no-verify -m "test"(绕过 hook),再跑 git commit -m "test",对比输出是否有 lint-staged 日志

lint-staged 配置为什么总不生效

常见现象是 commit 成功但完全没报错、没格式化——大概率是 glob 模式没匹配到暂存文件,或者规则命令根本没执行。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 确保 lint-staged 配置在 package.json 顶层,不是嵌套在 scripts 或其他字段里;若用独立配置文件,必须叫 .lintstagedrc.json 或 .lintstagedrc.js,不能是 lint-staged.config.js
  • glob 模式要覆盖实际暂存的文件后缀:"*.{js,ts,jsx,tsx}" 不会匹配 .vue 或 .svelte,得单独加
  • 命令数组里每个字符串都得是可执行命令:"eslint --fix" 要求项目本地装了 eslint,全局安装无效;同理 "prettier --write" 依赖本地 prettier
  • 如果用了 TypeScript,eslint --fix 可能报 parser 错误,得确认 @typescript-eslint/parser 已安装且 .eslintrc.cjs 中 parser 字段指向正确

ESLint 和 Prettier 冲突导致保存和提交行为不一致

保存时自动修复、提交时又报错,八成是两套规则打架。VSCode 的保存修复走的是编辑器层,而提交检查走的是 CLI 层,路径不同,配置加载可能不一致。

  • 必须在 .eslintrc.cjs 的 extends 数组末尾加上 "prettier",且 eslint-config-prettier 要本地安装,否则 ESLint 仍会启用自带的格式规则(如 indent、quotes)
  • .prettierrc 文件必须存在且位于项目根目录,内容不能有注释(JSON 不支持),也不能是 .prettierrc.js 里用 module.exports —— lint-staged 默认只读 JSON/YAML/JS 导出,但某些版本对 JS 格式支持不稳定
  • VSCode 设置里禁用 "editor.codeActionsOnSave": { "source.fixAll.prettier": true },只留 "source.fixAll.eslint": true;否则保存时 Prettier 和 ESLint 可能反复覆盖同一行
  • 验证方法:改一行缩进,保存后看是否只修正一次、无红色波浪线提示 “conflicting rule”,再 git add + commit 看是否通过

最容易被忽略的点:所有工具(husky、lint-staged、eslint、prettier)都必须本地安装,且配置文件严格放在项目根目录。VSCode 打开的文件夹如果不是根目录,插件和钩子都会失效——这不是 bug,是设计使然。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

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

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

1255

2023.06.30

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

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

2612

2023.07.21

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

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

1889

2024.03.14

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

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

1707

2024.03.14

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2587

2024.03.15

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1798

2024.03.15

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1242

2024.03.15

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

1096

2024.03.15

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

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

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