简介
@shingo/tslint-rules 是一个 TypeScript 的 lint 规则集，可以帮助开发者在代码编写过程中发现一些常见的代码错误或不规范的写法，从而提升代码的质量和可维护性。
此文章将介绍如何使用 @shingo/tslint-rules 进行代码检查。
安装
你可以通过 npm 在你的项目中安装 @shingo/tslint-rules:
npm install -D @shingo/tslint-rules
配置
使用 @shingo/tslint-rules 的第一步是配置 tslint，并在配置文件中引入规则集。
修改 tslint.json
在项目根目录下打开 tslint.json 文件，并添加以下代码：
-- -------------------- ---- -------
-
----------------- -
----------------------------------------------
--
-------- -
---------------------------------------- ----- -- ------------
------------------------------- ---- -- --------- -------
-
-规则说明
@shingo/explicit-function-return-type：强制函数有显式的返回类型。@shingo/no-floating-promises：禁止使用没有处理的 Promise。
你可以根据你自己的需求选择需要添加的规则，一般来说，建议把所有规则都开启。
使用
配置好规则后，你可以在命令行中直接使用 tslint 工具来 lint 你的代码：
tslint path/to/your/file.ts
如果你的文件中有不符合 @shingo/tslint-rules 的规则的语句，tslint 会在命令行中输出检查结果：
path/to/your/file.ts[1, 1]: error @shingo/explicit-function-return-type: Function has no explicit return type path/to/your/file.ts[2, 1]: error @shingo/no-floating-promises: Promise returned in function argument where a void return was expected
示例代码
这里是一个使用 @shingo/tslint-rules 的示例：
function add(a: number, b: number) {
return a + b;
}
add(1, 2)
.then(result => console.log(result))
.catch(err => console.error(err));根据 @shingo/tslint-rules 的 no-floating-promises 规则，最后两行会被认为是不符合规则的，并会在编译或执行中输出相应的错误信息。
总结
通过对代码进行 lint 操作，我们可以尽早地发现代码错误，并通过统一的 lint 规则来保证团队代码的可维护性。@shingo/tslint-rules 为我们提供了许多方便的 lint 规则，而使用灵活、简单。希望这篇文章能够帮助读者更好地使用该工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/205511