前言
在前端开发中，代码风格要保持一致是非常重要的。TSLint 是一个可以检查 TypeScript 代码风格和错误的工具。在 TypeScript 的生态中，urbanjs-tool-tslint 就是一个非常实用的 npm 包。
urbanjs-tool-tslint 集成了 TSLint，使 TypeScript 代码检查更加容易方便。urbanjs-tool-tslint 支持自动化测试，避免出现低级错误，提高代码可维护性。下面，我将详细介绍如何使用 urbanjs-tool-tslint。
安装
使用 npm 安装 urbanjs-tool-tslint。
npm install urbanjs-tool-tslint --save-dev
使用方式
安装完 urbanjs-tool-tslint 后，我们需要在项目根目录下新建一个名叫 .tslint.json 的文件。在这个文件中可以配置 urbanjs-tool-tslint 的规则等信息。
下面是一个 .tslint.json 的配置示例：
-- -------------------- ---- -------
-
-------- -
--------------------- -----
----------------------- -----
------------------ -----
-------- -----
------------- -----
---------- ------
-------- ------ ------------- --------------
-------------- -----
--------------------------- ------
----------- ------
-------------------- -----
------------- ------ -- -
------------- -
---
-------------- ------ ----
--
---------- -
---------------
--------------
-
-集成到项目中
在 package.json 文件的 scripts 字段中添加以下代码。
{
"scripts": {
"lint": "tslint -c ./tslint.json -p ./tsconfig.json 'src/**/*.ts'"
}
}加入以上代码后，我们可以在终端运行 npm run lint 来检查代码风格是否符合规范。
同时，你可能会在项目每次提交代码前完成代码风格的检查。这时，我们可以使用 husky 与 lint-staged。
- husky：在代码提交前在脚本中运行特定任务的工具。
- lint-staged：在提交前，对指定的 git 暂存区代码进行 lint 检测，若不符合规范，不允许提交。
在 package.json 中添加以下代码。
-- -------------------- ---- -------
-
-------- -
-------- -
------------- -------------
-
--
-------------- -
---------- -
------- ------
-
-
-总结
通过以上步骤，我们可以成功地集成 urbanjs-tool-tslint 并完成代码风格规范。代码规范的保持不仅可以使代码更容易维护，也能提高项目合作的效率。
代码库地址：https://github.com/urbanjs/urbanjs-tools
示例代码
-- -------------------- ---- -------
----- --- -
------- ------- -------
------------------ ------- -
----------- - ------
-
------ ------------ -------- ---- -
----------- - ------
-
------ ------ -------- ---- -
------------------ --- -------
-
-
----- ------ --- - --- -----------
---------------------
------------
-------------------来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562c981e8991b448e00e8