npm 包 unconfigured-eslint-rules 使用教程

阅读时长 3 分钟读完

最近,unconfigured-eslint-rules 这个 npm 包引起了我的注意。它是一个可以帮助你使用 ESLint 规则的 package,相比于手动配置 ESLint,他可以让你更加方便快捷地使用 ESLint。

安装

在使用该包之前,我们首先需要在自己的项目中安装它。可以通过以下命令在项目中进行安装:

如何使用

安装完成后,我们需要在 ESLint 的配置文件中指定序号化的规则,并添加你自己配置的规则。

以下是 .eslintrc.js 的示例文件:

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

在 rules 中,我们先通过 package 自带的 require-jsdoc 和 class-methods-use-this 关闭了两个 ESLint 规则,然后再添加了两个用户自定义的规则 prefer-const 和 no-var。

需要把 package 提供的规则 add 进你的 ESLint 配置文件中。

规则说明

unconfigured-eslint-rules 包中提供了很多好用的规则,以下是其中几个重点说明:

camelcase

强制使用驼峰命名法,对于属性和变量建议使用驼峰命名法,对于函数和方法建议使用帕斯卡命名法。

no-empty-function

禁止在代码块中出现空函数。比如以下示例中,doSomething 函数中什么都没有,并没有给我们提供任何实际的价值,建议将其删除:

no-magic-numbers

禁止在代码中使用魔法数字。魔法数字是指在代码中直接出现的数字常量,这些常量使得代码难以维护。建议将这些数字常量单独定义,并在之后直接使用变量。

require-await

强制 async 函数必须有 await 操作符。

总结

通过使用 unconfigured-eslint-rules,我们可以更加方便快捷地使用 ESLint。在实际开发中,通过添加各种规则,可以对我们的代码进行更加严格的检查,从而提高代码可维护性和可读性。

在使用本包的同时,请参照官方文档,理解各个规则,并在自己项目中进行添加和调整。

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

纠错
反馈