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}

Glimmer Ai
Glimmer Ai

基于GPT-3和DALL·E2的PPT制作工具

下载

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扩展并启用。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

194

2026.02.25

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

547

2023.08.23

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

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

335

2023.10.13

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

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

82

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

887

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

462

2024.06.27

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共42课时 | 9.5万人学习

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

共26课时 | 1.6万人学习

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

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