讲师中心 微信公众号
AI工具推荐 视频效率加速

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

轻芳君_2476

轻芳君_2476

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

|

166人浏览过

|

来源于php中文网

原创

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

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

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

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

一、安装必要扩展

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

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

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

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

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载

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工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

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

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

292

2026.02.13

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

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

520

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

371

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

286

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

638

2026.06.16

json数据格式
json数据格式

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

2175

2023.08.07

json是什么
json是什么

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

3382

2023.08.23

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

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

1136

2023.10.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

20

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

Buffalo框架快速入门指南
Buffalo框架快速入门指南

共0课时 | 0人学习

Valgrind支持平台说明
Valgrind支持平台说明

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn