0

0

代码质量保证方案_ESLint与Prettier的配合使用

夢幻星辰

夢幻星辰

发布时间:2025-12-02 11:32:02

|

1002人浏览过

|

来源于php中文网

原创

ESLint负责代码质量检查,Prettier专注格式化,通过eslint-config-prettier避免规则冲突;2. 安装相关依赖并配置.eslintrc.js和.prettierrc文件;3. 在VS Code中启用保存时自动格式化;4. 结合husky与lint-staged在提交前校验并修复代码,确保规范执行。

代码质量保证方案_eslint与prettier的配合使用

在现代前端开发中,保持代码的一致性和可维护性是团队协作的关键。ESLint 和 Prettier 是两个广泛使用的工具:ESLint 负责检测代码中的潜在问题和风格违规,Prettier 则专注于代码格式化。将它们配合使用,可以在保证代码质量的同时统一代码风格。

1. 工具分工明确

为了高效协作,需要明确 ESLint 与 Prettier 的职责边界:

  • ESLint:检查语法错误、潜在 bug、代码逻辑问题以及部分代码风格(如变量命名、禁止未使用变量等)
  • Prettier:统一格式化代码结构,包括缩进、引号、括号、换行、分号等视觉层面的样式

若两者在格式规则上冲突,会导致格式混乱或报错。因此,推荐使用 eslint-config-prettier 插件来关闭 ESLint 中与 Prettier 冲突的规则。

2. 安装与配置

在项目中集成 ESLint 与 Prettier 的基本步骤如下:

  1. 安装依赖:
npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier
  1. 创建或更新 .eslintrc.js 配置文件
module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:prettier/recommended' // 启用 Prettier 推荐配置并自动修复
  ],
  parserOptions: {
    ecmaVersion: 2021,
    sourceType: 'module'
  },
  env: {
    browser: true,
    es2021: true
  }
};
  1. 添加 .prettierrc 文件定义格式规则:
{
  "semi": true,
  "trailingComma": "es5",
  "singleQuote": true,
  "printWidth": 80,
  "tabWidth": 2
}
  1. 添加 .prettierignore 忽略不需要格式化的文件:
node_modules
dist
*.min.js

3. 编辑器集成

为了让开发者在编写代码时自动应用规则,建议在编辑器中配置保存时自动格式化。

以 VS Code 为例:

Bolt.new
Bolt.new

Bolt.new是一个免费的AI全栈开发工具

下载
  • 安装 ESLintPrettier 扩展
  • 在项目根目录的 .vscode/settings.json 中添加:
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

这样保存文件时会优先通过 ESLint 自动修复可修复的问题,并由 Prettier 统一格式化。

4. 与 Git 集成确保提交质量

防止不符合规范的代码进入仓库,可通过 husky + lint-staged 在提交前校验:

  1. 安装:
npm install --save-dev husky lint-staged
  1. 启用 husky 并设置钩子:
npx husky init
  1. 配置 package.json
"lint-staged": {
  "*.{js,jsx,ts,tsx}": [
    "eslint --fix",
    "prettier --write"
  ]
}
  1. 修改 .husky/pre-commit:
#!/bin/sh
npx lint-staged

这样每次 git commit 时都会对暂存文件执行 ESLint 修复和 Prettier 格式化,不通过则阻止提交。

基本上就这些。合理配置 ESLint 与 Prettier,能显著提升团队开发效率和代码一致性,减少代码评审中的风格争议。关键是明确分工、统一配置、自动化执行。不复杂但容易忽略细节。

相关专题

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

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

412

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的详细内容,可以访问本专题下面的文章。

309

2023.10.13

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

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

74

2025.09.10

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

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

510

2023.06.20

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

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

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

257

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5274

2023.08.17

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

25

2026.01.16

热门下载

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

精品课程

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

共34课时 | 2.5万人学习

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

共98课时 | 7.4万人学习

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

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