如何在 ESLint 中配置 Airbnb 代码规范的一些例外

如何在 ESLint 中配置 Airbnb 代码规范的一些例外

前言

随着前端开发技术的发展，代码规范已经变得越来越重要。在此背景下，Airbnb 发布的 JavaScript 代码规范已经成为前端开发中的一张“法律文书”，被越来越多的公司和团队所采用。然而，如果你已经使用过 Airbnb 代码规范，你会发现有时候它并不能完全满足你的需求，有些情况需要做一些例外。本文将介绍如何在 ESLint 中配置 Airbnb 代码规范的一些例外。

ESLint 配置

ESLint 是一个静态代码检查工具，可以帮助我们检查 JavaScript 代码的质量和规范性。Airbnb 代码规范是在 ESLint 的基础上定义的，如果你想要对 Airbnb 代码规范进行一些例外的配置，就需要对 ESLint 进行配置。

首先，我们需要安装 ESLint：

npm install eslint --save-dev

然后，在项目根目录下新建一个 .eslintrc 文件，配置 ESLint 规则：

{
  "extends": "airbnb",
  "rules": {
    "semi": ["error", "never"],
    "no-console": "off"
  }
}

在上面的配置中，我们使用 extends 属性继承了 Airbnb 代码规范，然后使用 rules 属性对 Airbnb 代码规范进行了一些例外的配置。其中，我们关闭了分号检查，并且允许使用 console。

常用例外配置

下面介绍一些常用的例外配置。

关闭分号检查

对于一些程序员来说，分号似乎并不是必须的，甚至会占用不必要的空间。ESLint 默认会检查分号的使用，但是在一些场景下，比如告诉语句的末尾和 if 语句的括号之间，可以不使用分号。我们可以通过下面的配置关闭分号检查：

{
  "rules": {
    "semi": ["error", "never"]
  }
}

允许使用 console

console 是 JavaScript 中常用的调试工具，有时候我们会在开发过程中使用它。但是，在生产环境中使用 console，会给性能带来严重的影响。ESLint 默认会禁止使用 console，但是我们可以通过下面的配置允许使用 console：

{
  "rules": {
    "no-console": "off"
  }
}

允许修改参数值

默认情况下，ESLint 不允许在函数参数内部重新赋值，但是在有些场景下，我们可能会需要这么做，比如操作对象的属性。我们可以通过下面的配置允许函数参数内部重新赋值：

{
  "rules": {
    "no-param-reassign": ["error", { "props": false }]
  }
}

允许使用 for in

ESLint 默认不允许使用 for in 循环，因为我们可以使用 for of 循环来代替它。但是在某些情况下，for in 循环可能更简单，我们可以通过下面的配置允许使用 for in：

-- -------------------- ---- -------
-
  -------- -
    ----------------------- -
      --------
      -----------------
      -------------------
      ---------------
    -
  -
-

总结

本文介绍了如何在 ESLint 中配置 Airbnb 代码规范的一些例外，并给出了一些常用的例外配置。希望这些例外配置能够帮助你更好地使用 Airbnb 代码规范。当然，如果你还有其他需要配置的地方，可以搜索 ESLint 文档，也可以在 .eslintrc 文件中自行定义规则。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/646efde2968c7c53b0d5fec3