JavaScript代码规范_ESLint规则配置

ESLint通过合理配置环境、语法和风格规则统一团队代码,提升可维护性。1. 设置env为browser、node、es6以启用对应全局变量与语法;2. parserOptions设ecmaVersion为2025、sourceType为module以支持现代JS;3. indent用2空格、quotes用单引号、semi强制分号、space-infix-ops要求操作符空格;4. 启用no-var、prefer-const、no-unused-vars、no-undef、no-shadow管理变量;5. eqeqeq强制全等、default-case和no-fallthrough规范switch、radix要求parseInt传进制;6. no-alert警告、no-console可设warn或off;7. 配合Prettier时使用eslint-config-prettier避免规则冲突;8. 团队需统一配置并持续执行。

JavaScript代码规范通过ESLint可以有效统一团队编码风格,提升代码可读性与维护性。关键在于合理配置规则,兼顾严谨性与开发体验。以下是常见且实用的ESLint规则配置建议,适用于大多数现代JavaScript项目。

基础环境与解析器设置

确保ESLint识别正确的语法和运行环境:

env:指定脚本运行环境,自动启用对应全局变量。

  • "browser": true —— 启用浏览器环境(window、document等)
  • "node": true —— 启用Node.js环境(require、module等)
  • "es6": true —— 启用ES6+语法支持

parserOptions:配置JavaScript语言选项。

  • "ecmaVersion": 2025 —— 支持较新的JS语法(如可选链、空值合并)
  • "sourceType": "module" —— 启用ES模块(import/export)

代码风格一致性规则

统一格式有助于减少代码审查中的格式争议:

  • "indent": ["error", 2] —— 使用2个空格缩进
  • "quotes": ["error", "single"] —— 字符串使用单引号
  • "semi": ["error", "always"] —— 每行结尾必须有分号
  • "no-multi-spaces": "error" —— 禁止多个连续空格
  • "space-infix-ops": "error" —— 操作符两侧加空格(a + b
  • "keyword-spacing": "error" —— 关键字前后空格一致(if (cond)

变量与作用域管理

避免意外错误和内存泄漏:

  • "no-unused-vars": "warn" —— 声明但未使用的变量提示警告
  • "no-undef": "error" —— 禁止使用未声明变量
  • "no-var": "error" —— 禁用var,强制使用let/const
  • "prefer-const": "error" —— 建议用const声明不重新赋值的变量
  • "no-shadow": "error" —— 禁止变量遮蔽外层作用域变量

最佳实践与潜在错误预防

提前发现易错写法,提高代码健壮性:

  • "eqeqeq": ["error", "always"] —— 强制使用===和!==
  • "no-alert": "warn" —— 警告使用alert/debugger
  • "no-console": "off""warn" —— 根据项目决定是否允许console
  • "default-case": "error" —— switch语句必须包含default分支
  • "no-fallthrough": "error" —— 防止switch case穿透未注释
  • "radix": "error" —— parseInt必须指定进制

基本上就这些。结合Prettier时建议使用eslint-config-prettier关闭格式类规则,避免冲突。实际项目中可根据团队习惯微调,重点是保持统一并持续执行。