前言
现今的前端工程开发中，JavaScript 代码质量是非常重要的。为了保证代码的可读性、可维护性和可扩展性，我们常常会使用一些开发工具来辅助我们编写代码。其中，ESLint 是一个非常出色的工具，它可以帮助我们检查代码中的语法错误、潜在问题、代码规范等等。eslint-config-availity 则是一种 eslint 的插件，它可以与现有的 ESLint 配置文件结合使用，提供了一些优秀的可读性和可维护性建议。
安装和使用
使用 eslint-config-availity，需要先安装 ESLint，然后再安装 eslint-config-availity 依赖。
npm install eslint --save-dev npm install eslint-config-availity --save-dev
待安装成功后，在项目的根目录中新建一个 .eslintrc 文件，内容如下：
{
"extends": [
"availity"
]
}这里配置的是 eslint-config-availity 为通用配置，这意味着会包含主流的最佳实践和规范，以及一些常见的 bug 的规避。
当你要对目录或者特定的文件进行检测时，则可自行新增或修改 .eslintrc 文件以覆盖所有或者特定规则。
可读性和可维护性建议
eslint-config-availity 支持很多的规则，这里只介绍一些常用的可读性和可维护性的建议。
补全缺失的 JSDocs 注释
注释在任何代码中都是非常重要的，特别是当您的代码被复查时。在团队合作开发时使用 JSDocs 注释也是非常不错的选择，让每个开发人员更容易读懂代码。
使用 eslint-config-availity 可以通过 enforce-eslint-comments 规则来让您的代码自动补全缺失的 JSDocs 注释。在 .eslintrc 文件中配置如下：
-- -------------------- ---- -------
-
-------- -
------------------------------------ --
--------------------------------------- --
----------------------------------- --
-------------------------------------- --- - ----------------- ---- ---
---------------------------------------- --
------------------------- --
-------------------------------------- --
-------------------------------- -
-
-校验循环语句和逻辑语句的代码块
在编写循环和逻辑语句的时候，代码块的可读性非常重要。eslint-config-availity 可以通过 no-lonely-if 和 no-empty 来校验是否没有遗漏或者多余的代码块。在 .eslintrc 文件中配置如下：
{
"rules": {
"no-lonely-if": 2,
"no-empty": 2
}
}另外一个常见的代码块为 switch 语句的 default 分支，eslint-config-availity 也对其进行了限制。在 .eslintrc 文件中配置如下：
{
"rules": {
"default-case": 2
}
}代码风格规范
使用 eslint-config-availity 还可以检查代码是否符合规范。在 .eslintrc 文件中配置如下：
-- -------------------- ---- -------
-
-------- -
--------------------- --
--------- --- ----------
------- --- ----------
---------------- --
------------------ --
---------------- --- - --------- ------ -------- ---- ---
--------------- --- - --------- ------ -------- ---- ---
-------------- --- - -------------- ------ ------------- ---- ---
---------------------- --
------------------------ --- ----------
---------------- --
-------------- -
-
-结论
在 JavaScript 代码编写中，使用 ESLint 和 eslint-config-availity 可以帮助我们检测语法错误、潜在问题、代码规范等等，降低代码的 bug 产生率。使用 eslint-config-availity 可以提供一些可读性和可维护性的建议。您可以根据您自己的情况逐步增加配置规则，以确保代码质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/196500