ESLint 是一种广泛使用的 JavaScript 代码静态检查工具,可以帮助你识别代码中的潜在问题,如语法错误、未使用的变量、不一致的代码风格等。以下是一些常见的 ESLint 代码规范建议:
-
变量声明:
- 使用
const
或let
声明变量,避免使用var
。 - 变量命名采用驼峰命名法(camelCase)。
- 使用
-
空格和缩进:
- 使用空格进行缩进,而不是制表符(tabs)。
- 操作符前后、逗号后需要有空格。
- 函数参数列表中的逗号后要有空格。
-
分号和引号:
- 语句末尾使用分号。
- 字符串使用单引号(除非你需要在字符串内部使用单引号,那么可以使用双引号)。
-
函数声明:
- 函数声明后的大括号要换行。
- 函数名与括号之间不要有空格。
-
字符串拼接:
- 使用模板字符串进行字符串拼接。
-
数组和对象:
- 数组和对象的大括号后要有空格。
-
换行:
- 每行代码长度不超过 80 个字符。
-
注释:
- 注释要写在正确的位置,解释代码的目的和功能。
- 尽量避免注释掉无用的代码。
-
命名规范:
- 变量、函数和类的命名要有意义。
- 避免使用魔术数字(magic numbers),尽量使用命名常量代替。
-
错误处理:
- 进行错误处理,并尽可能提供有用的错误信息。
-
避免全局变量:
- 尽量避免使用全局变量,使用模块化的方式进行开发。
-
ESLint 规则配置:
- 在项目根目录下创建一个
.eslintrc.js
或.eslintrc.json
文件,用于存放 ESLint 的配置信息。 - 在配置文件中,可以使用
rules
属性来定义自定义规则。每个规则都是一个键值对,键是规则名称,值是规则的配置选项。 - 规则的配置选项可以是字符串(表示规则的严重程度)、对象或数组。
- 在项目根目录下创建一个
-
使用 ESLint 插件和解析器:
- ESLint 支持各种插件和解析器,可以扩展其功能和支持其他语言。
- 例如,你可以使用
@typescript-eslint/parser
插件来支持 TypeScript 代码的 linting。
-
代码格式化:
- 可以结合使用 Prettier 这样的代码格式化工具,与 ESLint 一起使用,以确保代码风格的一致性。
-
强制执行规范:
- 使用 ESLint 工具,通过配置文件中的规则来强制执行代码规范。在开发过程中,ESLint 可以在保存文件时自动修复一些简单的代码问题。