npm 包 tslint-config-jotang 使用教程

阅读时长 3 分钟读完

tslint-config-jotang 是一个基于 TSLint 的代码风格检查工具,使用它可以帮助我们梳理代码,并遵循统一的代码规范,提高代码质量和可维护性。本教程将详细介绍如何安装和使用这个 npm 包。

安装

命令中的 --dev 表示这个包只用于开发环境。

配置

在你项目的根目录下新建 tslint.json 文件,并将以下代码贴入。

这样就配置成功了,继续往下看,还有提高使用效率的诀窍。

提高效率

tslint-config-jotang 提供了各种代码规范检查的配置,但默认情况下并非所有配置项都开启了,因此我们需要手动开启。下面介绍几个常用的配置项。

semicolon

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

这个配置项用于检查是否在语句末尾使用了分号,包括 class 的方法定义。这里的 ignore-bound-class-methods 表示忽略在 constructor 中使用 bind 函数绑定 this 的方法。

object-literal-spacing

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

这个配置项用于检查对象字面量的花括号和属性之间是否有空格。设置为 always 表示需要有空格。

quotemark

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

这个配置项用于检查引号的使用方式,比较常用的设置为 singledouble。其中 jsx-single 表示在 JSX 中要使用单引号。

示例代码

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

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

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

以上代码符合 tslint-config-jotang 的规范,可以通过代码检查。若在某行末尾忘记加分号,则会被提示错误。

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

纠错
反馈