npm 包 @blueprintjs/tslint-config 使用教程

阅读时长 3 分钟读完

在进行前端开发的过程中,使用 TypeScript 已经成为了一种非常流行的趋势,而对于我们的代码规范,则有了一个相对统一的标准 - tslint。在 tslint 的规则集中,我们需要针对每个项目的不同情况去选择针对性的规则集,而 @blueprintjs/tslint-config 就是一个非常好用的针对 TypeScript 项目的规则集。

安装

在使用 @blueprintjs/tslint-config 之前,我们需要先安装依赖:

接下来,我们在项目根目录下,新建一个名为 tslint.json 的文件,输入以下内容:

至此,我们已经完成了安装和配置 @blueprintjs/tslint-config 的基本工作,现在我们可以在项目中愉快地使用它了。

使用

@blueprintjs/tslint-config 中默认启用的规则已经满足了大部分 TypeScript 项目的需求,其中包含了很多的最佳实践和代码质量相关的规则。如果某些规则不符合我们的项目需求,或者想要增加一些规则,也可以在 tslint.json 中进行修改或者添加。

接下来,我们就可以对我们的 TypeScript 项目进行运行 tslint 来检查代码规范了。在 tsconfig.json 中加入以下内容:

然后运行以下命令即可进行代码风格检查:

示例

以下是一个简单的示例代码:

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

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

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

在运行 npm run lint 后,我们可以得到以下的输出信息:

这是因为 @blueprintjs/tslint-config 中开启了 typedef 规则,所有的函数需要定义返回值类型,我们可以对该示例代码进行修改:

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

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

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

重新运行 npm run lint 后,我们就可以得到一个干净的代码检查结果。“蓝图”色调的错误信息十分醒目且易于理解,非常的友好。

结语

@blueprintjs/tslint-config 这个 npm 包虽然不是很大而且并不复杂,但是它为我们规范了日常的项目开发习惯,可以大大提高代码质量和可读性,而这需求至关重要。任何一款优秀的 npm 包,都应该具备良好的可用性和调试性,并且不断地伴随着开发者培训与学习,让前端开发真正地走向成熟和完善。

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

纠错
反馈