0

0

一键格式化代码:在VSCode中配置Prettier与ESLint

P粉986688829

P粉986688829

发布时间:2026-01-09 17:57:07

|

146人浏览过

|

来源于php中文网

原创

prettier与eslint需协同配置才能实现vscode保存时自动格式化:安装扩展、初始化项目依赖、设置默认格式化工具、整合冲突规则并验证生效。

一键格式化代码:在vscode中配置prettier与eslint

如果您在VSCode中编写JavaScript或TypeScript代码,但每次保存后代码未自动按统一风格格式化,则可能是Prettier与ESLint未正确协同配置。以下是实现一键格式化代码的具体操作步骤:

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

一、安装必要扩展

VSCode需通过扩展支持Prettier和ESLint的解析与格式化能力,缺少任一扩展将导致格式化指令无法识别或执行失败。

1、打开VSCode左侧活动栏中的扩展图标(四个方块组成的图标)。

2、在搜索框中依次输入并安装以下两个扩展:PrettierESLint

3、安装完成后,重启VSCode确保扩展完全加载。

二、初始化项目依赖

本地项目需具备Prettier和ESLint的可执行命令,否则VSCode扩展仅能提供语法提示而无法实际运行格式化逻辑。

1、在项目根目录下打开终端,执行 npm init -y 初始化package.json(若尚未初始化)。

2、运行命令安装开发依赖:npm install --save-dev prettier eslint eslint-config-prettier eslint-plugin-prettier

3、创建.prettierrc文件,写入基础配置如:{"semi": true, "singleQuote": true}

三、配置VSCode默认格式化工具

VSCode需明确指定使用Prettier作为JavaScript/TypeScript文件的默认格式化程序,否则保存时可能调用内置格式器而非Prettier。

1、按下 Cmd + ,(Mac)或 Ctrl + ,(Windows/Linux)打开设置界面。

Mokker AI
Mokker AI

AI产品图添加背景

下载

2、在右上角点击“打开设置(JSON)”图标,进入settings.json编辑模式。

3、在JSON中添加以下键值对:"editor.defaultFormatter": "esbenp.prettier-vscode"

4、同时加入:"editor.formatOnSave": true,启用保存时自动格式化。

四、整合ESLint与Prettier冲突规则

ESLint与Prettier可能对相同代码风格(如分号、引号)产生相反校验,需通过配置使ESLint禁用与Prettier重叠的规则,避免报错或格式化反复修正。

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

2、写入配置导出对象,其中extends数组必须包含 "plugin:prettier/recommended" 且置于最后。

3、确保plugins字段包含 "prettier",rules字段中添加 "prettier/prettier": "error"

五、验证格式化是否生效

完成全部配置后,需通过真实代码触发保存行为,观察是否执行Prettier格式化并同步通过ESLint校验,以确认二者已协同工作。

1、新建test.js文件,输入未格式化代码如:const a=1;function f(){return a;}

2、按下 Cmd + S(Mac)或 Ctrl + S(Windows/Linux)保存文件。

3、检查代码是否自动变为:const a = 1;​
function f() {
  return a;
}

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

43

2026.02.13

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

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

116

2026.02.25

json数据格式
json数据格式

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

452

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

326

2023.10.13

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

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

81

2025.09.10

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

411

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

366

2023.10.25

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

48

2026.02.28

热门下载

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

精品课程

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

共48课时 | 10万人学习

Git 教程
Git 教程

共21课时 | 4万人学习

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

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