0

0

集成ESLint与Prettier的VSCode代码质量保障方案

夜晨

夜晨

发布时间:2025-11-12 23:58:03

|

370人浏览过

|

来源于php中文网

原创

首先安装VSCode的ESLint和Prettier扩展,并在项目中本地安装eslint、prettier及相关插件;接着通过.eslintrc.js配置extends为'eslint:recommended'和'plugin:prettier/recommended',确保ESLint与Prettier协同工作;然后创建.prettierrc文件定义semi、singleQuote、trailingComma等格式规则;再在.vscode/settings.json中设置editor.formatOnSave为true,并启用codeActionsOnSave以实现保存时自动修复;最后通过.eslintignore和.prettierignore排除node_modules、dist等无需检查的文件;该方案可实现保存时自动格式化与错误修复,保障团队代码风格统一与质量提升。

在现代前端开发中,保持代码风格统一和高质量是团队协作的关键。通过集成 eslint 与 prettier 到 vscode,可以实现保存时自动格式化、语法检查、错误提示等能力,大幅提升开发效率和代码可维护性。下面是一套实用且被广泛采用的配置方案。

安装必要的扩展与依赖

要让 ESLint 和 Prettier 协同工作,首先需要在项目中安装相关工具,并在 VSCode 中启用对应插件。

1. 安装 VSCode 扩展:

  • ESLint(由 Microsoft 提供)
  • Prettier - Code formatter

这两个扩展可在 VSCode 扩展市场搜索安装。安装后,编辑器能实时显示 lint 错误并支持 Prettier 格式化。

2. 项目本地安装依赖:

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

推荐将这些工具作为开发依赖安装到项目中,避免全局版本不一致带来的问题。

配置 ESLint 与 Prettier 协同工作

默认情况下,ESLint 和 Prettier 可能会因规则冲突而报错。使用 eslint-config-prettier 禁用所有与格式化相关的 ESLint 规则,再通过 eslint-plugin-prettier 把 Prettier 作为 ESLint 的“规则”执行,确保二者统一。

创建或更新项目根目录下的 .eslintrc.js 文件:

module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:prettier/recommended' // 启用 Prettier 推荐配置
  ],
  env: {
    browser: true,
    es2021: true,
  },
  parserOptions: {
    ecmaVersion: 12,
  },
};

该配置启用了 ESLint 推荐规则,并通过 plugin:prettier/recommended 自动整合 Prettier,避免规则冲突。

同时,在项目根目录创建 .prettierrc 文件定义格式偏好:

酷兔AI论文
酷兔AI论文

专业原创高质量、低查重,免费论文大纲,在线AI生成原创论文,AI辅助生成论文的神器!

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

配置 VSCode 实现保存时自动修复

为了让编辑器在保存文件时自动格式化并修复可修复的 ESLint 问题,需调整 VSCode 设置。

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

或者在 .vscode/settings.json 中添加:

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

这样,保存文件时会优先由 ESLint 修复问题(如引号、分号等),再交由 Prettier 进行结构化格式化,流程清晰且无冲突。

忽略不需要检查的文件

某些文件如构建产物、第三方库不应参与 lint 与格式化。可通过以下文件排除:

  • .eslintignore:指定 ESLint 忽略的路径
  • .prettierignore:指定 Prettier 忽略的路径

示例内容:

node_modules
dist
build
*.min.js

基本上就这些。这套方案已在多个团队项目中验证,能有效保障代码质量与风格统一,配置一次,长期受益。

相关专题

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

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

415

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

310

2023.10.13

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

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

75

2025.09.10

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

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

639

2023.07.31

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

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

431

2024.06.27

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

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

510

2023.06.20

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

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

244

2023.07.28

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

5

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
go语言零基础开发内容管理系统
go语言零基础开发内容管理系统

共34课时 | 2.6万人学习

第二十三期_前端开发
第二十三期_前端开发

共98课时 | 7.5万人学习

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

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