0

0

如何在VSCode中配置ESLint和Prettier以规范代码

P粉986688829

P粉986688829

发布时间:2025-12-06 07:53:07

|

953人浏览过

|

来源于php中文网

原创

在 VSCode 中同时配置 ESLint 和 Prettier 的关键是协同分工:ESLint 检查代码质量与错误,Prettier 统一格式;需安装对应扩展与依赖(eslint、prettier、eslint-config-prettier、eslint-plugin-prettier),配置 .eslintrc.js 启用 plugin:prettier/recommended,设置 .prettierrc 定义格式规则,并在 VSCode 中启用 Format On Save、设置默认 Formatter 为 Prettier、配置 codeActionsOnSave 自动修复 ESLint 问题。

如何在vscode中配置eslint和prettier以规范代码

在 VSCode 中同时配置 ESLint 和 Prettier,关键在于让两者协同工作:ESLint 负责代码质量与潜在错误检查,Prettier 负责统一格式(缩进、引号、换行等),避免规则冲突。

安装必要扩展和依赖

先确保本地项目和编辑器都装好了基础工具

  • VSCode 扩展:安装 ESLint(由 Dirk Baeumer 维护)和 Prettier(由 Esben Petersen 开发)两个官方推荐插件
  • 项目依赖:在项目根目录运行以下命令(推荐使用 --save-dev
npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier

其中 eslint-config-prettier 用于关闭 ESLint 中与 Prettier 冲突的规则,eslint-plugin-prettier 则把 Prettier 当作 ESLint 的一条规则来执行(比如自动修复格式问题)。

配置 ESLint 规则(.eslintrc.js 或 .eslintrc.json

在项目根目录创建 .eslintrc.js,内容示例如下:

module.exports = {
  extends: [
    "eslint:recommended",
    "plugin:prettier/recommended"
  ],
  plugins: ["prettier"],
  rules: {
    "prettier/prettier": "error"
  }
};

注意"plugin:prettier/recommended" 已内置 eslint-config-prettier,会自动禁用所有与 Prettier 冲突的规则,无需手动写 extends: ["eslint-config-prettier"]

配置 Prettier 选项(.prettierrc)

在项目根目录新建 .prettierrc(JSON 格式),定义你想要的格式风格:

CodiumAI
CodiumAI

AI代码测试工具,在IDE中获得重要的测试建议

下载
{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5"
}

这些设置会直接影响 ESLint 的 prettier/prettier 规则报错和自动修复行为。VSCode 的 Prettier 插件也会读取它来做实时格式化。

设置 VSCode 自动修复与保存行为

打开 VSCode 设置(Ctrl+, 或 Cmd+,),搜索并勾选或配置以下几项:

  • Format On Save:启用,确保保存时自动格式化
  • Default Formatter:设为 esbenp.prettier-vscode(即 Prettier 插件)
  • ESLint: Auto Fix On Save:在设置中搜 “eslint.autoFixOnSave”,启用(注意:VSCode 1.8x+ 后该选项已移至 editor.codeActionsOnSave

更推荐的方式是在 settings.json(用户或工作区)中添加:

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

这样保存时先由 ESLint(含 Prettier 规则)统一修复,再由 Prettier 做最终格式化,流程清晰不重复。

基本上就这些。配置完成后重启 VSCode,打开一个 JS/TS 文件,修改后保存,就能看到错误提示、自动修复和格式统一同步生效了。

相关专题

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

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

418

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

76

2025.09.10

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

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

719

2023.07.31

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

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

431

2024.06.27

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

188

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

291

2023.10.25

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

58

2026.01.23

热门下载

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

精品课程

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

共21课时 | 3万人学习

Kotlin 教程
Kotlin 教程

共23课时 | 2.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

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