讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

updream

一键生成高质量推广成片

VSCode中的代码格式化:Prettier与ESLint的完美结合

风晨同学_6248

风晨同学_6248

发布时间:2025-12-31 08:56:02

|

172人浏览过

|

来源于php中文网

原创

Prettier与ESLint需协同配置才能解决VSCode中JavaScript/TypeScript格式化不一致问题:安装对应扩展与本地依赖,配置.eslintrc.js禁用冲突规则并启用plugin,设置.prettierrc定义格式偏好,通过.vscode/settings.json指定默认格式化器并开启保存自动修复,最后验证三者同步生效。

vscode中的代码格式化:prettier与eslint的完美结合

如果您在VSCode中编写JavaScript或TypeScript代码,但发现格式化行为不一致、代码风格冲突或保存时未自动修复问题,则可能是Prettier与ESLint配置未协同工作。以下是实现二者完美结合的具体操作步骤:

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

一、安装必要扩展与依赖

VSCode需通过官方扩展支持Prettier和ESLint的集成,同时项目本地需安装对应工具包以确保规则执行一致性。全局安装可能导致版本差异,因此优先采用本地依赖方式。

1、在VSCode扩展市场中搜索并安装Prettier与ESLint两个扩展,确保状态为已启用。

2、在项目根目录下执行命令:npm init -y(若尚无package.json)。

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

二、配置ESLint以兼容Prettier

ESLint默认规则可能与Prettier冲突,需通过eslint-config-prettier禁用所有格式化类规则,并用eslint-plugin-prettier将Prettier作为ESLint的插件运行,使错误提示与格式化统一输出。

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

2、写入以下内容:

module.exports = {

extends: ['eslint:recommended', 'plugin:prettier/recommended'],

plugins: ['prettier'],

rules: { 'prettier/prettier': 'error' }

};

三、配置Prettier规则文件

Prettier需独立配置其格式化偏好,避免依赖ESLint覆盖全部样式控制。使用.prettierrc文件可明确定义缩进、引号、行宽等核心格式参数。

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

2、写入标准JSON格式配置,例如:

{

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载

"semi": true,

"singleQuote": true,

"tabWidth": 2,

"trailingComma": "es5"

}

四、设置VSCode工作区格式化行为

VSCode需明确指定默认格式化工具为Prettier,并启用保存时自动修复,同时防止ESLint扩展重复触发格式化造成覆盖冲突。

1、在项目根目录创建.vscode/settings.json文件(若不存在)。

2、写入以下配置项:

{

"editor.defaultFormatter": "esbenp.prettier-vscode",

"editor.formatOnSave": true,

"editor.codeActionsOnSave": { "source.fixAll.eslint": true },

"eslint.validate": ["javascript", "typescript", "javascriptreact", "typescriptreact"]

}

五、验证集成效果

完成配置后,需通过实际代码触发校验与格式化流程,确认ESLint报错、Prettier格式化及保存修复三者是否同步生效。

1、新建一个test.js文件,输入含空格不一致、缺少分号、双引号等违反Prettier+ESLint联合规则的代码。

2、保存文件,观察编辑器是否自动修正缩进与引号,并在问题面板中显示prettier/prettier类错误提示。

3、手动触发命令面板(Cmd+Shift+P),执行ESLint: Fix all auto-fixable Problems,检查是否无残留格式类报错。

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

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

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

DeepSeek

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

豆包大模型

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

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

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

332

2026.02.13

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

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

540

2026.02.25

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

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

411

2026.03.13

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

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

326

2026.06.03

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

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

758

2026.06.16

json数据格式
json数据格式

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

2335

2023.08.07

json是什么
json是什么

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

3842

2023.08.23

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

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

1276

2023.10.13

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

20

2026.11.12

热门下载

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

精品课程

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

共58课时 | 12.5万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

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

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