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)打开设置界面。

Keeva AI
Keeva 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;
}

相关专题

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

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

549

2023.06.20

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

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

373

2023.07.04

js四舍五入
js四舍五入

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

730

2023.07.04

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

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

475

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

394

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代码放置在一个独立的文件。

656

2023.09.12

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

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

551

2023.09.20

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

3

2026.01.09

热门下载

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

精品课程

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

共48课时 | 6.9万人学习

Git 教程
Git 教程

共21课时 | 2.5万人学习

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

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