0

0

VSCode的Prettier与ESLint:配置完美的自动化代码格式化流程

P粉986688829

P粉986688829

发布时间:2026-01-02 10:06:08

|

787人浏览过

|

来源于php中文网

原创

VSCode中Prettier与ESLint协同需:一、安装二者扩展并禁用其他格式化工具,启用format on save;二、安装eslint-config-prettier并在.eslintrc.js的extends末尾添加'prettier';三、创建.prettierrc并设"editor.defaultFormatter"为Prettier;四、开启eslint.autoFixOnSave但避免格式类规则冲突;五、配置.editorconfig统一基础编辑行为。

vscode的prettier与eslint:配置完美的自动化代码格式化流程

如果您在VSCode中同时使用Prettier与ESLint,但发现代码保存后格式化行为不一致、规则冲突或未自动执行,则可能是由于插件配置未协同、优先级未明确或扩展设置缺失。以下是实现二者协同工作的具体配置步骤:

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

一、安装必要扩展并禁用冲突格式化工具

确保VSCode仅依赖Prettier与ESLint进行格式化,避免其他格式化插件(如JavaScript Standard Style、Beautify)干扰其执行顺序和结果。

1、打开VSCode扩展市场,搜索并安装PrettierESLint官方扩展。

2、在扩展列表中查找已启用的其他代码格式化类插件,逐个点击右键选择禁用

3、进入设置(Cmd+,),搜索format on save,确认已勾选Editor: Format On Save

二、配置ESLint以识别Prettier规则

通过eslint-config-prettier关闭ESLint中与Prettier重叠的样式类规则,防止二者报错冲突或重复修正。

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

2、打开项目中的.eslintrc.js文件,在extends数组末尾添加'prettier'

3、确认该配置项位于所有可能启用样式规则的配置之后,例如:['eslint:recommended', 'plugin:react/recommended', 'prettier']

三、设置Prettier为默认格式化工具

强制VSCode在保存时调用Prettier执行格式化,并将ESLint保留为仅校验逻辑错误与潜在问题的工具。

1、在项目根目录创建.prettierrc文件,写入基础配置如:{"semi": true, "singleQuote": true, "tabWidth": 2}

启科网络PHP商城系统
启科网络PHP商城系统

启科网络商城系统由启科网络技术开发团队完全自主开发,使用国内最流行高效的PHP程序语言,并用小巧的MySql作为数据库服务器,并且使用Smarty引擎来分离网站程序与前端设计代码,让建立的网站可以自由制作个性化的页面。 系统使用标签作为数据调用格式,网站前台开发人员只要简单学习系统标签功能和使用方法,将标签设置在制作的HTML模板中进行对网站数据、内容、信息等的调用,即可建设出美观、个性的网站。

下载

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

3、同时设置:"editor.formatOnSave": true"editor.formatOnSaveMode": "file"

四、启用ESLint自动修复且不覆盖Prettier格式

让ESLint在保存时仅修复其职责范围内的问题(如变量未使用、函数定义错误),而不触碰缩进、引号、分号等由Prettier接管的格式项。

1、在settings.json中添加:"eslint.autoFixOnSave": true

2、添加配置项:"eslint.validate": ["javascript", "typescript", "vue"](按实际语言调整)。

3、在.eslintrc.js中确保rules内未启用任何与eslint-config-prettier禁用项重复的格式类规则,例如'no-unused-vars'可保留,而'quotes'应被禁用。

五、使用.editorconfig统一基础编辑器行为

作为Prettier与ESLint之外的补充层,.editorconfig可提前约束换行符、缩进风格等底层编辑器行为,减少格式化前的原始差异。

1、在项目根目录创建.editorconfig文件。

2、写入以下内容:root = true\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true

3、确认VSCode已安装EditorConfig for VS Code扩展并启用。

相关专题

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

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

544

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源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

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

精品课程

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

共42课时 | 5.8万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.4万人学习

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

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