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}

雾象
雾象

WaytoAGI推出的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,确认无格式类报错,且输出中仅剩语义性警告(如未使用变量)。

热门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

热门下载

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

精品课程

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

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

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