0

0

VSCode代码检查与格式化:ESLint与Prettier深度集成

夢幻星辰

夢幻星辰

发布时间:2025-11-16 14:39:40

|

325人浏览过

|

来源于php中文网

原创

正确配置ESLint与Prettier可实现代码质量与风格统一。ESLint检查逻辑错误,Prettier统一代码格式,通过安装eslint-config-prettier和eslint-plugin-prettier避免规则冲突,结合VSCode的保存自动格式化及lint-staged提交前校验,确保团队协作高效、代码规范一致。

vscode代码检查与格式化:eslint与prettier深度集成

在现代前端开发中,代码质量与风格统一至关重要。VSCode 作为主流编辑器,结合 ESLint 与 Prettier 能实现高效的代码检查与格式化。正确集成二者,不仅能提升协作效率,还能减少低级错误。

ESLint 与 Prettier 的角色分工

ESLint 主要负责代码质量检查,比如变量未使用、语法错误、潜在 bug 等。它通过规则集帮助团队遵循一致的编码规范。

Prettier 是代码格式化工具,专注于代码样式:缩进、引号、括号、换行等。它不关心逻辑问题,只确保代码外观统一。

两者功能互补,但默认规则可能冲突。例如 ESLint 要求单引号,而 Prettier 默认双引号。因此需要合理配置,避免互相干扰。

项目级配置:安装与依赖管理

在项目根目录初始化 npm 并安装必要依赖:

npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier

eslint-config-prettier 关闭所有与 Prettier 冲突的 ESLint 规则。

eslint-plugin-prettier 将 Prettier 作为 ESLint 规则运行,格式错误会在 ESLint 中提示。

创建或更新 .eslintrc.js 配置文件

module.exports = { extends: [ 'eslint:recommended', 'plugin:prettier/recommended' // 启用 Prettier 推荐配置 ], rules: { // 可在此覆盖个别规则 } };

添加 .prettierrc 定义格式化偏好:

{ "semi": true, "singleQuote": true, "tabWidth": 2, "trailingComma": "es5" }

VSCode 设置:自动保存时格式化

确保 VSCode 使用项目本地的 ESLint 和 Prettier,而非全局版本。安装以下扩展:

Detect GPT
Detect GPT

一个Chrome插件,检测您浏览的页面是否包含人工智能生成的内容

下载
  • ESLint(由 Microsoft 提供)
  • Prettier - Code formatter

在 VSCode 的 settings.json 中添加:

{ "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll.eslint": true }, "eslint.workingDirectories": ["./"] }

这样在保存文件时,ESLint 会自动修复可修复的问题,Prettier 执行格式化。

若项目有多个工作区,eslint.workingDirectories 帮助 VSCode 正确定位 ESLint 配置。

常见问题与最佳实践

有时格式化未生效,可能是默认格式化器未指定。右键编辑器 → “格式化文档” → 选择 Prettier 并设为默认。

避免全局安装 Prettier 或 ESLint,使用项目本地依赖保证团队一致性。

提交前可用 lint-staged 结合 Husky 自动检查修改文件:

// package.json "lint-staged": { "*.{js,ts,jsx,tsx}": ["eslint --fix", "prettier --write"] }

这样能防止不符合规范的代码进入仓库。

基本上就这些。配置一次,长期受益。关键是让工具协同工作,而不是对抗。

相关专题

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

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

415

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

75

2025.09.10

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

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

510

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字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

258

2023.08.03

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

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

5288

2023.08.17

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

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

精品课程

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

共34课时 | 2.6万人学习

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

共98课时 | 7.5万人学习

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

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