0

0

代码规范:ESLint配置与Prettier格式化

betcha

betcha

发布时间:2025-11-22 08:07:35

|

484人浏览过

|

来源于php中文网

原创

ESLint 与 Prettier 结合可统一代码风格并提升质量。1. ESLint 检测代码问题,通过 .eslintrc.js 配置环境、规则、插件等;2. Prettier 负责格式化,通过 .prettierrc 定义缩进、引号、分号等样式;3. 使用 eslint-config-prettier 禁用冲突规则,eslint-plugin-prettier 将 Prettier 作为 ESLint 规则;4. 集成到编辑器(如 VS Code)实现保存自动修复;5. 配置 npm 脚本进行 lint 和 format;6. 结合 Husky + lint-staged 在提交前自动校验,确保代码规范落地。

代码规范:eslint配置与prettier格式化

在现代前端开发中,保持代码的一致性和可读性至关重要。ESLint 和 Prettier 是两个广泛使用的工具:ESLint 用于检测代码中的潜在问题并 enforce 编码规范,Prettier 则专注于代码格式化。将两者结合使用,可以实现既严格又统一的代码风格。

ESLint 配置详解

ESLint 能帮助开发者发现代码中的错误、不规范写法和潜在 bug。一个典型的 ESLint 配置文件(.eslintrc.js)通常包括以下几个部分:

  • env:指定代码运行环境,如浏览器、Node.js 等,以便识别全局变量
  • extends:继承已有的规则集,比如推荐配置或第三方规范(如 airbnb、standard)
  • plugins:引入额外的插件,如 reactvue、import 等
  • rules:自定义具体规则的开启/关闭及严重程度("error"、"warn"、"off")
  • parserOptions:指定语法解析选项,如支持 ES2022、JSX、TypeScript 等
示例配置:
module.exports = {
  env: {
    browser: true,
    es2021: true,
    node: true,
  },
  extends: [
    'eslint:recommended',
    'plugin:react/recommended'
  ],
  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
    ecmaFeatures: {
      jsx: true
    }
  },
  plugins: ['react'],
  rules: {
    'no-console': 'warn',
    'eqeqeq': ['error', 'always'],
    'semi': ['error', 'never']
  },
  settings: {
    react: {
      version: 'detect'
    }
  }
};

Prettier 基础配置

Prettier 是一个“开箱即用”的代码格式化工具,它会强制统一代码样式,减少团队间的格式争议。其核心配置通过 .prettierrc 文件定义。

  • semi:是否在语句末尾加分号
  • singleQuote:是否使用单引号代替双引号
  • tabWidth:缩进空格数
  • useTabs:是否使用制表符而非空格
  • printWidth:每行最大长度,超过则换行
  • trailingComma:对象或多参数末尾是否保留逗号
示例配置(.prettierrc):
{
  "semi": false,
  "singleQuote": true,
  "tabWidth": 2,
  "printWidth": 80,
  "trailingComma": "es5"
}

ESLint 与 Prettier 协同工作

直接同时启用 ESLint 和 Prettier 可能导致规则冲突(例如分号、引号)。为避免此类问题,建议使用 eslint-config-prettiereslint-plugin-prettier 进行整合。

  • eslint-config-prettier:关闭所有与 Prettier 冲突的 ESLint 规则
  • eslint-plugin-prettier:将 Prettier 作为 ESLint 规则运行,格式错误会在 ESLint 中提示
安装依赖:
npm install --save-dev eslint-config-prettier eslint-plugin-prettier prettier
更新 .eslintrc.js:
extends: [
  'eslint:recommended',
  'plugin:react/recommended',
  'prettier' // 关闭冲突规则
],
plugins: ['react', 'prettier'],
rules: {
  'prettier/prettier': 'error' // 启用 Prettier 格式检查
}

这样,ESLint 不仅检查代码质量,还会报告格式问题,统一通过编辑器或命令行修复。

citySHOP 多用户商城
citySHOP 多用户商城

citySHOP是一款集CMS、网店、商品、系统,管理更加科学快速;全新Jquery前端引擎;智能缓存、图表化的数据分析,手机短信营销;各种礼包设置、搭配购买、关联等进一步加强用户体验;任何功能及设置都高度自定义;MVC架构模式,代码严禁、规范;商品推荐、促销、礼包、折扣、换购等多种设置模式;商品五级分类,可自由设置分类属性;商品展示页简介大方,清晰,图片自动放大,无需重开页面;商品评价、咨询分开

下载

集成到开发环境

为了让规范真正落地,应将 ESLint 和 Prettier 集成到编辑器和项目流程中。

  • 在 VS Code 中安装 ESLintPrettier 插件,保存时自动格式化
  • 配置 .vscode/settings.json 实现保存时自动修复
  • 添加 npm 脚本进行批量检查与修复
package.json 示例脚本:
"scripts": {
  "lint": "eslint src/**/*.js",
  "lint:fix": "eslint src/**/*.js --fix",
  "format": "prettier --write src/**/*.{js,jsx,json}"
}

结合 Git Hooks(如 Husky + lint-staged),可在提交代码前自动校验和格式化,防止不符合规范的代码进入仓库。

基本上就这些。合理配置 ESLint 与 Prettier,不仅能提升代码质量,还能增强团队协作效率。关键是统一标准,并让工具自动执行,减少人为干预。不复杂但容易忽略。

相关专题

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

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

408

2023.08.07

json是什么
json是什么

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

532

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

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

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

617

2023.07.31

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

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

430

2024.06.27

scripterror怎么解决
scripterror怎么解决

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

187

2023.10.18

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

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

271

2023.10.25

Java 项目构建与依赖管理(Maven / Gradle)
Java 项目构建与依赖管理(Maven / Gradle)

本专题系统讲解 Java 项目构建与依赖管理的完整体系,重点覆盖 Maven 与 Gradle 的核心概念、项目生命周期、依赖冲突解决、多模块项目管理、构建加速与版本发布规范。通过真实项目结构示例,帮助学习者掌握 从零搭建、维护到发布 Java 工程的标准化流程,提升在实际团队开发中的工程能力与协作效率。

8

2026.01.12

热门下载

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

精品课程

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

共42课时 | 6.3万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.4万人学习

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

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