0

0

VSCode中如何优雅地格式化代码(Prettier + ESLint)

P粉986688829

P粉986688829

发布时间:2025-12-20 13:13:10

|

487人浏览过

|

来源于php中文网

原创

Prettier与ESLint协同实现VSCode保存即格式化、编辑即提示:需安装官方扩展、配置项目依赖及规则文件、设置默认格式化器与保存行为,并按语言类型单独指定格式化器。

vscode中如何优雅地格式化代码(prettier + eslint)

如果您在 VSCode 中编写代码时发现格式混乱、风格不统一,可能是缺少自动化的代码格式化与校验工具。Prettier 负责统一代码样式,ESLint 负责检测潜在错误与编码规范问题,二者协同可实现保存即格式化、编辑即提示的开发体验。以下是配置与使用该组合的具体步骤:

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

一、安装必要扩展

VSCode 需通过扩展支持 Prettier 和 ESLint 的集成能力,必须安装对应官方插件以启用语法高亮、实时诊断和自动修复功能。

1、打开 VSCode 左侧活动栏的扩展图标(或按 Cmd+Shift+X)。

2、在搜索框中依次输入并安装:Prettier - Code formatterESLint 两个扩展。

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, "tabWidth": 2}

三、配置 ESLint 规则文件

ESLint 需明确知道如何与 Prettier 协作,避免规则冲突;通过 extends 组合官方推荐配置,可自动禁用与 Prettier 冲突的规则。

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

Ai好记
Ai好记

强大的AI音视频转录与总结工具

下载

2、写入如下内容:module.exports = {extends: ['eslint:recommended', 'plugin:prettier/recommended']};

3、确保 node_modules/.bin/eslint 可被 VSCode 正确识别为 ESLint CLI 路径。

四、设置 VSCode 默认格式化器与保存行为

VSCode 必须明确将 Prettier 设为当前工作区的默认格式化工具,并启用保存时自动格式化,才能实现“优雅”的一键操作。

1、按下 Cmd+, 打开设置界面,在右上角点击“打开 settings.json”图标。

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

3、继续添加:"editor.formatOnSave": true"editor.codeActionsOnSave": {"source.fixAll.eslint": true}

五、按语言单独指定格式化器

某些项目包含多种语言(如 Vue、TypeScript),需为不同文件类型显式绑定格式化器,防止 Prettier 错误处理非 JS/TS 文件。

1、在 VSCode 设置中搜索 files.associations,添加:{"*.vue": "vue"}

2、在 settings.json 中新增 "[vue]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}

3、对 TypeScript 文件,添加:"[typescript]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

50

2026.02.13

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

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

199

2026.02.25

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

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

121

2026.03.13

json数据格式
json数据格式

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

458

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

84

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

532

2023.06.20

Python WebSocket实时通信与异步服务开发实践
Python WebSocket实时通信与异步服务开发实践

本专题聚焦 Python 在实时通信场景中的开发实践,系统讲解 WebSocket 协议原理、长连接管理、消息推送机制以及异步服务架构设计。内容包括客户端与服务端通信实现、连接稳定性优化、消息队列集成及高并发处理策略。通过完整案例,帮助开发者构建高效稳定的实时通信系统,适用于聊天应用、实时数据推送等场景。

7

2026.03.18

热门下载

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

精品课程

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

共42课时 | 9.7万人学习

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号