0

0

怎样配置VSCode在提交前自动格式化代码并运行lint检查?

狼影

狼影

发布时间:2025-09-26 21:26:01

|

997人浏览过

|

来源于php中文网

原创

配置Prettier和ESLint实现代码格式化与检查,2. 通过Husky和lint-staged在git commit前自动执行格式化与lint,3. 统一团队配置确保代码风格一致,最终实现提交前自动化代码质量保障。

怎样配置vscode在提交前自动格式化代码并运行lint检查?

要在提交代码前让 VSCode 自动格式化并运行 lint 检查,不能仅靠编辑器本身设置完成,需要结合 Git 的 husky 和代码检查工具(如 ESLint、Prettier)来实现。VSCode 提供格式化支持,但自动触发是在 Git 提交阶段通过钩子完成的。

1. 安装并配置 Prettier 和 ESLint

确保项目中已安装并配置好代码格式化和检查工具:
  • 在项目根目录运行:npm install --save-dev prettier eslint
  • 创建或更新 .prettierrc 配置文件(例如设置缩进、引号等)
  • 配置 .eslintrc.js.eslintrc.json,启用你想要的规则
  • package.json 中添加脚本:
    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"

同时,在 VSCode 中设置默认格式化工具:

  • 打开命令面板(Ctrl+Shift+P)
  • 输入 “Preferences: Open Settings (JSON)”
  • 添加以下内容:
{ "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll.eslint": true } }

这样保存时会自动格式化并修复 ESLint 可修复的问题。

Type
Type

生成草稿,转换文本,获得写作帮助-等等。

下载

2. 使用 Husky 和 lint-staged 在提交前检查

要实现在 git commit 前自动格式化和 lint,需使用 husky 触发 pre-commit 钩子。
  • 安装依赖:
    npm install --save-dev husky lint-staged
  • 启用 Husky:
    npx husky init
  • 修改生成的 .husky/pre-commit 文件:
#!/bin/sh npx lint-staged
  • package.json 中添加 lint-staged 配置:
"lint-staged": { "*.{js,jsx,ts,tsx}": [ "prettier --write", "eslint --fix" ] }

这样每次执行 git commit 时,会先对暂存区的文件运行 Prettier 格式化和 ESLint 修复,如果有错误无法修复,提交会被中断。

3. 确保团队统一配置

为了防止不同开发环境产生格式差异,建议:
  • .vscode/settings.json 提交到仓库(可选,但需团队共识)
  • 提供统一的 .prettierrc.eslintrc.editorconfig
  • 在 README 中说明开发环境要求

基本上就这些。VSCode 负责编辑时的即时反馈,而真正的“提交前检查”是靠 husky + lint-staged 实现的。这套流程能有效保证提交到仓库的代码始终整洁合规。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

419

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

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

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

514

2023.06.20

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

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

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5321

2023.08.17

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

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

精品课程

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

共34课时 | 2.6万人学习

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

共98课时 | 7.6万人学习

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

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