在前端开发中，TSLint 是一个非常重要的工具，它可以帮助我们进行代码静态检查，确保代码质量和一致性。但是，在使用 TSLint 的时候，我们往往需要自己配置一些规则，这一过程需要花费很多时间和精力。为了解决这个问题，@dhainzl 开发了一个 NPM 包 @dhainzl/ng-tslint-config。
本文将会介绍如何在 Angular 项目中使用 @dhainzl/ng-tslint-config 这个包。
安装
在使用本包之前，我们首先需要安装它。我们可以使用以下命令来安装它：
npm install @dhainzl/ng-tslint-config --save-dev
--save-dev表示这个包只是用于开发阶段，并不是项目的依赖。
配置
安装完成之后，我们需要在项目中进行配置。我们可以在项目的根目录下创建一个 tslint.json 文件，并将以下内容复制进去：
{
"extends": "@dhainzl/ng-tslint-config"
}然后，我们就可以使用 tslint 命令来进行代码检查了。例如，我们可以输入以下命令来检查代码：
tslint src/**/*.ts
规则
@dhainzl/ng-tslint-config 包含了许多常用的 TSLint 规则。下面，我们将介绍一些常见的规则。
no-console
这个规则会检查代码中是否有 console.log 或者 console.error 等语句。在生产环境中，我们一定不希望这些语句出现在代码中，因为它们会影响代码的性能。因此，在开发阶段，我们应该避免使用这些语句。
no-redundant-jsdoc
这个规则会检查代码中是否有多余的 JSDoc 注释。在 TypeScript 中，我们可以使用类型来定义函数参数和返回值，因此我们不需要在 JSDoc 注释中重复定义。
quotemark
这个规则会检查代码中字符串的引号是否一致。例如，我们应该使用 ' 或者 " 中的一种来定义字符串，而不是混合使用。
typedef
这个规则会检查代码中是否定义了变量的类型。在 TypeScript 中，我们可以使用类型来显式地定义变量的类型。使用这个规则可以让代码更加清晰和易于维护。
whitespace
这个规则会检查代码中的空格是否符合规范。例如，我们应该在运算符周围加上空格，这样可以让代码更加易读。该规则还可以检查代码中行尾是否有多余的空格。
示例代码
下面是一个 TypeScript 类的示例代码，它符合了 @dhainzl/ng-tslint-config 包中的所有规则。
-- -------------------- ---- -------
-- -------
---
- - ---- ------- ------
--
----- ---- -
------- ----- -------
---
- ------- - --- -------- -- -----
- ------ ---- - --- ---- -- --- ---------
--
----------------- ------- -
--------- - -----
-
---
- ---- --- ---- -- --- ---------
- -------- --- ---- -- --- ---------
--
---------- ------ -
------ ----------
-
-下面是一个 TypeScript 文件的示例代码，它包含了一些不符合规范的代码。
-- -------------------- ---- -------
-- ------
----- --- -
------- ----- -------
----------------- ------- -
-- ---- ------- ------- -- --- --------
--------------------- --- -------- -- --- ---- ---------------
--------- - -----
-
---------- ------ -
-- ---- --------- ----- --------
---
- ---- --- ---- -- --- ---------
- -------- --- ---- -- --- ---------
--
------ ----------
-
-结论
@dhainzl/ng-tslint-config 包含了许多常用的 TSLint 规则，可以帮助我们提高代码质量和一致性。在使用它的时候，我们只需要安装并配置即可。同时，我们也可以根据自己的需求进行定制，从而更好地适应我们的项目。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a630d092702382251f