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 并写入:

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 定义格式规范:

Whimsical
Whimsical

Whimsical推出的AI思维导图工具

下载
{
  "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"
  ]
}

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

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

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

553

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

731

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

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

共58课时 | 3.6万人学习

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

共12课时 | 1.0万人学习

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

共12课时 | 1万人学习

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

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