0

0

VSCode代码格式化指南:Prettier与ESLint的完美结合

P粉986688829

P粉986688829

发布时间:2026-01-01 19:07:03

|

161人浏览过

|

来源于php中文网

原创

VSCode中Prettier与ESLint需协同配置以实现自动格式化与静态检查:安装扩展及devDependencies,用eslint-config-prettier禁用冲突规则,.prettierrc定义格式选项,VSCode设置默认格式器并启用保存时格式化。

vscode代码格式化指南:prettier与eslint的完美结合

如果您在VSCode中编写JavaScript或TypeScript代码,但发现格式化行为不一致、代码风格混乱或ESLint警告未被自动修复,则可能是Prettier与ESLint配置未协同工作。以下是实现二者无缝集成的具体步骤:

本文运行环境:MacBook Air,macOS Sequoia。

一、安装必要扩展与依赖

VSCode需通过官方扩展支持Prettier和ESLint,项目本地也需安装对应npm包以确保规则执行一致性。全局安装可能导致版本冲突,因此推荐项目级依赖管理。

1、在VSCode扩展市场中搜索并安装PrettierESLint两个官方扩展。

2、在项目根目录下执行命令:npm install --save-dev prettier eslint eslint-config-prettier eslint-plugin-prettier

3、确认package.json中已存在devDependencies条目,包含上述四个包且版本号非^0.0.0*

二、配置ESLint以兼容Prettier

ESLint默认规则可能与Prettier冲突(如引号风格、分号使用),需通过eslint-config-prettier禁用所有格式化类规则,并用eslint-plugin-prettier将Prettier作为ESLint的可执行规则。

1、在项目根目录创建.eslintrc.js文件,内容包含extends: ['eslint:recommended', 'plugin:prettier/recommended']

2、确保plugin:prettier/recommended位于extends数组末尾,使其覆盖优先级最高。

3、检查rules字段中未手动启用与prettier重复的规则,例如quotessemicomma-dangle等。

三、配置Prettier核心选项

Prettier自身需明确格式偏好,其配置独立于ESLint,但影响最终输出结果。VSCode将依据此配置执行保存时格式化。

1、在项目根目录创建.prettierrc文件,写入JSON格式配置,例如:{"semi": true, "singleQuote": true, "tabWidth": 2, "printWidth": 80}

千图设计室AI海报
千图设计室AI海报

千图网旗下的智能海报在线设计平台

下载

2、若使用TypeScript,添加"parser": "typescript".prettierrc中(仅当Prettier版本≥2.8.0时支持)。

3、创建.prettierignore文件,填入node_modules/dist/build/等无需格式化的路径。

四、设置VSCode编辑器行为

VSCode必须明确指定默认格式化工具及触发时机,否则可能调用内置格式器或无响应。需同时配置用户级与工作区级设置以保障一致性。

1、打开VSCode设置(Cmd+,),搜索format on save,勾选Editor: Format On Save

2、在工作区设置.vscode/settings.json中添加:"editor.defaultFormatter": "esbenp.prettier-vscode"

3、添加关键覆盖项:"editor.formatOnSaveMode": "modifications",避免全文件重排引发大量diff。

五、验证集成效果

配置完成后需通过真实代码检验是否真正协同:ESLint应仅报告逻辑问题,Prettier应接管全部格式化输出,且保存操作能同时满足两者要求。

1、新建test.js文件,输入含双引号、无分号、超长行的代码段。

2、按下Cmd+S保存,观察代码是否自动转为单引号、补充分号、折行至80列以内。

3、在终端运行npx eslint test.js --fix,确认无格式类报错,且输出中仅剩语义性警告(如未使用变量)。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

543

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

392

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

654

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

544

2023.09.20

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

65

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 1.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

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

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