1. 简介
Rxjs-tslint-rules 是使用 TypeScript 开发的一种工具，旨在为 TypeScript 项目中的 RxJS 代码提供一套可靠的代码规范。它是一种能够扩展 TSLint 进行检查编译代码质量，从而帮助开发者保障代码质量的工具。
Rxjs-tslint-rules 依赖于 TSLint 和 RxJS 6.x，检查的时候提供一些简单的，可定制的浏览器警告，来帮助开发者发现潜在的问题。
2. 安装
安装的时候直接在项目中安装 rxjs-tslint-rules，运行以下命令：
npm install rxjs-tslint-rules --save-dev
上述命令会在项目的 package.json 文件中添加 rxjs-tslint-rules 安装信息，安装好后可以检查是否成功安装：
node_modules/.bin/tslint -p tsconfig.json --config node_modules/rxjs-tslint-rules/dist/config.json src/*.ts
Rxjs-tslint-rules 的初始化成功后，如果您使用的是 Visual Studio Code 编辑器，推荐安装 TSLint 插件，以便于支持 Rxjs-tslint-rules 更好的查看。
3. 用法
使用 Rxjs-tslint-rules 前，用户需要手动修改项目中 tslint.json 配置文件，并且集成 Rxjs-tslint-rules 到 TSLint 检查器中。
首先，将下面的设置添加到您的 tslint.json 文件中：
-- -------------------- ---- -------
-
----------------- -
-------------------------------------
--
-------- -
---------------------------- -----
------------------------------- -----
---------------------------- -----
------------------------- -
-----
-
------------ -----
----------------- ----
-
-
-
-这将使 TSLint 能够查找 Rxjs-tslint-rules 的规则文件并根据这些规则文件执行检查。
4. 规则列表
Rxjs-tslint-rules 提供了以下的规则列表：
rxjs-explicit-return-type
检查型号推断的 Observable 是否有明确的返回类型，默认为 true。
推荐配置：
{
"rxjs-explicit-return-type": true
}rxjs-pipeable-operators-only
禁止使用追加 Observable 的操作符，只允许使用管道操作符（pipeable operatros）。所有的操作符和修饰符必须在管道中使用。
推荐配置：
{
"rxjs-pipeable-operators-only": true
}rxjs-take-while-predicate
检查 takeUntil 操作符中是否是一个有效的逻辑，而不是使用简单的 true 表达式。
推荐配置：
{
"rxjs-take-while-predicate": true
}rxjs-naming-convention
为 RxJS 规则命名进行统一性检查，默认推荐命名规则为带有 $ 符号作为结尾。
推荐配置：
-- -------------------- ---- -------
-
------------------------- -
-----
-
------------ -----
----------------- ----
-
-
-示例代码
本文示例代码在 Angular 6.x 组件中使用：
-- -------------------- ---- -------
------ - ---------- ------ - ---- ----------------
------ - ----- - ---- -------
------------
--------- ------------
------------ -------------------------
---------- -------------------------
--
------ ----- -------------- ---------- ------ -
-------- - ---
---------- -
-------- -----------
---------- ------ -- ---------------- --------------
--------------
-
-5. 总结
通过本教程，我们可以得知 Rxjs-tslint-rules 可以完美地兼容 TypeScript 项目，并为开发人员提供一套完整的 RxJS 代码风格指南。Rxjs-tslint-rules 使用显示型号推断的可观察类型及其表达式，以保障代码的质量，更为详细的部分可以参考官方文档。Rxjs-tslint-rules 为开发者提供了一种可定制的配置工具，是开发者必备利器之一。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/61019