npm 包 eslint-config-affinita 使用教程

阅读时长 4 分钟读完

前言

在前端开发中,为了保证团队协作和代码质量,我们通常会使用代码风格检查工具。其中,eslint 是一个非常常用的工具,他可以通过配置规则来检查代码的风格,以及发现一些潜在的 bug。在实际应用中,我们可以使用一些预设规则来快速配置 eslint。本文将介绍一个开源的预设规则包:eslint-config-affinita,它是由 Affinita 公司发布的一套 eslint 规则。

安装

我们可以通过 npm 安装 eslint-config-affinita:

使用

在安装完成后,在项目根目录下创建 .eslintrc.json 文件。然后在文件中添加如下配置:

这里我们是将 eslint 的预设规则指向到了 affinita 这个包中定义的规则。

配置

在默认情况下,eslint-config-affinita 会启用如下规则:

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

在这些规则中,包括了一些通用的 eslint 规则,比如说 semiquotesindent 等等。同时,它也覆盖了一些 eslint 规则,包括了一些关于代码风格的细节。我们可以根据实际需求和团队风格来进行配置。

示例代码

为了更好的说明说明 eslint-config-affinita 的使用,我们来看下面这段示例代码:

使用 eslint 配置后的代码:

eslint-config-affinita 会根据配置要求提示我们将逗号放在最后一项,来保证代码的风格统一。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600566dd81e8991b448e32e8

纠错
反馈