0

0

Prettier + ESLint:在VS Code中实现代码的自动格式化与校验

P粉986688829

P粉986688829

发布时间:2025-11-24 20:08:02

|

824人浏览过

|

来源于php中文网

原创

Prettier 和 ESLint 结合可在 VS Code 中实现代码规范与美观。1. 安装 Prettier 与 ESLint 扩展;2. 项目中安装 eslint、prettier、eslint-config-prettier、eslint-plugin-prettier 依赖;3. 配置 .eslintrc.js 使用 plugin:prettier/recommended,避免规则冲突;4. 创建 .prettierrc 定义格式化选项;5. 在 VS Code 设置中启用 formatOnSave,并指定 Prettier 为默认格式化工具,同时开启 codeActionsOnSave 自动修复 ESLint 问题;6. 推荐在项目级 .vscode/settings.json 中配置,防止影响其他项目;7. 若格式化未生效,检查文件类型识别与默认 formatter 设置,查看日志排查;8. 部分 ESLint 错误无法自动修复需手动处理;9. 确保引入 eslint-config-prettier 以消除规则冲突。配置完成后,保存即格式化,提升开发效率与团队协作一致性。

prettier + eslint:在vs code中实现代码的自动格式化与校验

想在 VS Code 中让代码既规范又美观?Prettier 和 ESLint 结合使用是目前最主流的方案。Prettier 负责代码格式化,ESLint 负责代码质量校验,两者分工明确。配合 VS Code 的保存自动修复功能,可以实现保存即格式化、自动修复问题的效果。

安装必要的扩展和依赖

先确保你在项目中正确安装并配置了 Prettier 和 ESLint。

1. 安装 VS Code 扩展:

  • Prettier - Code formatter
  • ESLint

这两个扩展可在 VS Code 插件市场中直接搜索安装。

2. 在项目中安装依赖(推荐本地安装):

npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier

其中:

  • eslint-config-prettier:关闭 ESLint 中与 Prettier 冲突的规则
  • eslint-plugin-prettier:将 Prettier 作为 ESLint 规则运行,有问题会显示在 ESLint 提示中

配置 ESLint 与 Prettier 协同工作

在项目根目录创建或修改 .eslintrc.js.eslintrc.json

module.exports = { extends: [ "eslint:recommended", "plugin:prettier/recommended" // 启用 Prettier 推荐配置 ], rules: { // 可自定义额外规则 } };

这个配置会自动启用 Prettier,并避免规则冲突。

论论App
论论App

AI文献搜索、学术讨论平台,涵盖了各类学术期刊、学位、会议论文,助力科研。

下载

你也可以单独创建 .prettierrc 文件来定义格式化偏好:

{ "semi": true, "trailingComma": "es5", "singleQuote": true, "printWidth": 80, "tabWidth": 2 }

设置 VS Code 实现保存时自动格式化

打开 VS Code 设置(Ctrl + ,),搜索 “format on save”,勾选 Editor: Format On Save

或者在 settings.json 中添加:

{ "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll.eslint": true } }

说明:

  • defaultFormatter 指定 Prettier 为默认格式化工具
  • formatOnSave 保存时自动格式化
  • codeActionsOnSave 会触发 ESLint 自动修复可修复的问题

注意:如果项目中有多个 formatter,建议在项目级 .vscode/settings.json 中设置,避免影响其他项目。

处理常见问题

格式化未生效?
检查文件类型是否被识别正确,确认 Prettier 是否设为默认 formatter,查看输出面板中的 ESLint 或 Prettier 日志。

ESLint 报错但无法自动修复?
部分规则(如命名、逻辑错误)不能自动修复,需手动调整。可通过 npx eslint . --fix 尝试批量修复。

Prettier 和 ESLint 规则冲突?
确保已启用 eslint-config-prettier,它会关闭所有与格式相关的 ESLint 规则,避免重复报错。

基本上就这些。配置一次,长期受益。写代码更专注,团队协作也更顺畅。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

312

2023.10.13

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

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

77

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

824

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

436

2024.06.27

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

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

515

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

245

2023.07.28

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

33

2026.01.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
2022大前端凭啥拿高薪?
2022大前端凭啥拿高薪?

共6课时 | 2.1万人学习

PHP代码整洁之道
PHP代码整洁之道

共7课时 | 7万人学习

http状态码大全
http状态码大全

共47课时 | 107.8万人学习

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

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