0

0

JavaScript代码规范_ESLint与Prettier团队协作配置

betcha

betcha

发布时间:2025-11-29 19:39:06

|

336人浏览过

|

来源于php中文网

原创

eslint与prettier配合可统一代码风格,提升协作效率。1. eslint检查代码质量,prettier处理格式化;2. 安装eslint、prettier及相关插件;3. 配置.eslintrc.js,extends中加入'prettier'并启用prettier/prettier规则;4. 创建.prettierrc定义格式规范;5. 编辑器安装eslint和prettier插件,开启保存自动格式化;6. 可选配置lint-staged和husky在提交前自动检查与修复。配置文件需纳入版本控制,确保团队一致。

javascript代码规范_eslint与prettier团队协作配置

在团队协作开发中,保持 JavaScript 代码风格统一是提升可读性、减少冲突和提高维护效率的关键。ESLint 和 Prettier 是目前最主流的代码检查与格式化工具组合。合理配置二者协同工作,能有效避免风格争议,让团队专注业务逻辑。

为什么需要 ESLint + Prettier 配合

ESLint 负责代码质量检查(如未使用变量、潜在错误),也可处理部分代码风格问题;Prettier 则专注于代码格式化(缩进、引号、括号等),强制统一输出样式。两者分工明确:ESLint 管“对不对”,Prettier 管“好不好看”。

若不加以整合,可能出现 ESLint 与 Prettier 规则冲突(例如分号、引号风格)。因此需通过 eslint-config-prettier 禁用所有与格式相关的 ESLint 规则,交由 Prettier 统一处理。

基础依赖安装

项目根目录执行以下命令安装必要依赖:

立即学习Java免费学习笔记(深入)”;

  • npm install --save-dev eslint prettier
  • npm install --save-dev eslint-config-prettier eslint-plugin-prettier
  • npm install --save-dev @babel/eslint-parser(如使用 Babel)

若使用 React:

  • npm install --save-dev eslint-plugin-react

ESLint 配置文件(.eslintrc.js

创建 .eslintrc.js 并写入:

Q.AI视频生成工具
Q.AI视频生成工具

支持一分钟生成专业级短视频,多种生成方式,AI视频脚本,在线云编辑,画面自由替换,热门配音媲美真人音色,更多强大功能尽在QAI

下载
module.exports = {
  env: {
    browser: true,
    es2021: true,
    node: true,
  },
  extends: [
    'eslint:recommended',
    'plugin:react/recommended',
    'prettier', // 必须放在最后,关闭与 Prettier 冲突的 ESLint 规则
  ],
  parser: '@babel/eslint-parser',
  parserOptions: {
    ecmaVersion: 12,
    sourceType: 'module',
    ecmaFeatures: {
      jsx: true,
    },
  },
  plugins: ['react', 'prettier'],
  rules: {
    'prettier/prettier': 'error', // 启用 Prettier 格式检查
    'no-unused-vars': 'warn',
    'no-console': 'off',
  },
  settings: {
    react: {
      version: 'detect',
    },
  },
};

Prettier 配置文件(.prettierrc)

创建 .prettierrc 定义格式规范:

{
  "semi": true,
  "trailingComma": "es5",
  "singleQuote": true,
  "printWidth": 80,
  "tabWidth": 2,
  "useTabs": false,
  "arrowParens": "avoid"
}

支持 JSON、YAML 或 .prettierrc.js 格式。团队应统一选择一种并提交到仓库。

集成到开发环境

确保编辑器自动格式化并提示 ESLint 错误:

  • VS Code 安装插件:ESLint、Prettier - Code formatter
  • 启用保存自动修复:"editor.formatOnSave": true
  • 设置默认格式化工具为 Prettier

这样开发者在保存文件时,Prettier 自动格式化,ESLint 检查语法和规则,即时反馈问题。

配合 Git 提交拦截(可选)

使用 lint-stagedHusky 在提交前自动检查与格式化:

  • npm install --save-dev lint-staged husky
  • package.json 中添加:
"husky": {
  "hooks": {
    "pre-commit": "lint-staged"
  }
},
"lint-staged": {
  "*.{js,jsx}": [
    "eslint --fix",
    "prettier --write",
    "git add"
  ]
}

这样可防止不符合规范的代码被提交,保障仓库代码整洁。

基本上就这些。配置一次,全队受益。关键是把配置文件纳入版本控制,确保所有人使用同一套规则。团队协作不再因空格还是制表符争论。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

453

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

331

2023.10.13

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

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

82

2025.09.10

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

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

530

2023.06.20

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

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

554

2023.07.28

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

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

738

2023.08.03

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

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

6065

2023.08.17

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

44

2026.03.06

热门下载

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

精品课程

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

共58课时 | 5.8万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1.1万人学习

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

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