简介
Journey-tslint 是 TypeScript 项目中一种常用的代码规范检查工具。它基于 TSLint 进行扩展，提供了一些预定义的规则以及配置选项，可以帮助我们更好地维护代码规范。本文将为大家介绍如何使用 journey-tslint 进行 TypeScript 项目的代码规范检查。
安装 journey-tslint
在使用 journey-tslint 之前，我们需要安装它。可以通过 npm 来安装：
npm install --save-dev journey-tslint tslint
--save-dev：将 journey-tslint 安装为开发依赖。tslint：是 journey-tslint 的依赖项，需要一起安装。
配置 journey-tslint
安装好 journey-tslint 后，我们需要对其进行一些配置，以便它能够正常运作，并根据项目需求进行一些自定义配置。
在项目根目录下新建一个文件：tslint.json
-- -------------------- ---- -------
-
---------- -
----------------
--
-------- -
---------------- ------ --------------- ----------------
------------------------------ -----
------------- ------ ---------
------------------ ------ -----
------------ ------ ----------
---------------------------- ------ -------------
--------------------------- -----
--
------------ ---------
-上述配置文件中：
extends：是 journey-tslint 的规则配置的扩展点，使用 journey-tslint 规则。rules：自定义规则。formatter：指定生成的报告格式，默认使用prose格式。
运行 journey-tslint
在配置好 journey-tslint 后，我们需要运行 journey-tslint 进行代码规范检查。
假设我们有如下代码：
// src/index.ts
let number: number;
function add(a: number, b: number): number {
return a + b;
}
add(number, 2);我们使用 journey-tslint 进行代码规范检查的命令为：
npx tslint -c tslint.json src/index.ts
其中：
npx tslint：使用本地的 journey-tslint 进行代码规范检查。-c tslint.json：指定配置文件路径。src/index.ts：指定要检查的文件。
执行命令后，journey-tslint 会分析我们的代码，并输出带有错误信息的报告。
示例代码
现在，让我们来看一下 journey-tslint 的使用示例。假设我们有如下代码：
-- -------------------- ---- -------
-- ------------
---- --- - -
----- -------
----- ----- - ------
-------- -------
--
-------- --------- ---- ----- ------- -
-- ------------- -
---------- - --
-
-- --------- --- ------ -
-- ----- --- ------- -
---------- -- --
-
-
-
------ ----- ------ ----- ----- -- --------这段代码有很多不符合 code style 的写法：
weight是一个可选属性，但在feed函数里面进行了处理，不应该是可选的。- 在
feed函数中，没有对参数进行类型检查。 - 在
feed函数中，对 pet 的类型进行了不必要的字符串字面量对比。
我们可以使用 journey-tslint 对这段代码进行格式化、检查代码质量等方面的处理，来优化代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/journey-tslint