npm 包 `eslint-config-yarus` 使用教程

在前端开发中，使用代码规范工具可以帮助我们更加规范地编写代码，减少后续 bug 的产生。在 JavaScript 生态圈中，eslint 是一个非常常用的代码规范工具。而 eslint-config-yarus 便是其中一个可用的配置方案。

安装

首先，我们需要在项目中安装 eslint 和 eslint-config-yarus。可以使用以下命令进行安装：

npm install --save-dev eslint eslint-config-yarus

添加 --save-dev 参数是因为我们只需要在开发环境中使用 eslint，而不需要在生成环境中使用。

安装完成后，在项目中的 node_modules 目录下应该可以看到这两个包。

配置

在安装完成后，接下来就是配置 eslint。创建一个 .eslintrc.json 文件，并在其中添加以下代码：

{
  "extends": "eslint-config-yarus",
  "rules": {
    // 这里写入您的自定义规则
  }
}

这里，我们使用 eslint-config-yarus 作为基础配置。您也可以使用其他 eslint 的基础配置，但注意需要与 eslint-config-yarus 中的配置进行兼容。比如，使用 airbnb-base 作为基础配置：

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

规则

现在您可以在项目中直接使用 eslint 来进行规范检查了。但需要注意的是，eslint-config-yarus 并不仅仅包含默认的规则，而且还包括可选规则和插件。

以下是 eslint-config-yarus 中定义的规则：

您可以在 .eslintrc.json 文件中使用这些规则作为基础规则来进行项目的规范检查。

自定义规则

这里提供一些自定义规则的示例。

禁止无用的变量定义

考虑下面这个例子：

var a = 1;
console.log(a);

这段代码中定义了一个变量 a，但后续会直接使用它。因此可以声明一个 no-unused-vars 规则来禁止这种情况的发生：

{
  "rules": {
    "no-unused-vars": "error"
  }
}

禁止使用 var

在新的 EcmaScript 标准出台后，推荐使用 let 和 const 来代替 var。因此，可以定义一个 no-var 规则来禁止使用 var：

{
  "rules": {
    "no-var": "error"
  }
}

禁止使用 eval

使用 eval 可能会引起安全问题，因此可以声明一个 no-eval 规则来禁止使用它：

{
  "rules": {
    "no-eval": "error"
  }
}

结语

在本文中，我们介绍了如何使用 eslint-config-yarus 来进行前端项目的代码规范管理。eslint-config-yarus 囊括了常用的代码规范，并提供了可选规则和插件。通过本文的学习，相信您已经可以熟练使用 eslint-config-yarus 来规范自己的代码了。

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