前端开发过程中，我们经常需要写出清晰易读的代码，并保持代码的一致性。然而，由于多人参与的开发过程中，常常会出现代码规范不一致的情况。这时候，我们就需要使用一些专业的工具来规范代码风格。
在 TypeScript 和 JavaScript 领域中，TSLint 是一个非常流行的静态代码分析工具，它可以帮助我们在编写代码时捕获潜在的错误，并提供一些代码风格的建议。
在本文中，我们将深入学习 @jedmao/tslint 这个 npm 包，并介绍如何在项目中使用它来进行代码检查。
安装和配置
首先，我们需要安装 @jedmao/tslint 包：
npm install --save-dev @jedmao/tslint
接下来，在项目根目录中创建一个名为 tslint.json 的文件。这个文件用来配置 @jedmao/tslint 的检查规则。
我们可以在配置文件中添加需要检查的规则，以及一些我们希望应用的代码风格。
以下是一个示例的配置文件：
-- -------------------- ---- -------
-
---------- -----------------
-------- -
------------- ------
---------------------------- ------ -------------
--------------------------- -----
--
---------- --
-"extends": "@jedmao/tslint"表示这个配置文件是基于 @jedmao/tslint 预先定义好的规则进行修改；"rules"是我们可以自定义的规则，其中"array-type": false禁用了检查数组类型的规则，"object-literal-key-quotes": [true, "as-needed"]定义了对象字面量中 key 的引号用法，"object-literal-sort-keys": false禁用了检查对象字面量 key 排序的规则。
在配置好 tslint.json 文件后，我们可以在 TypeScript 或者 JavaScript 代码中使用 // tslint:disable-next-line 注释来临时关闭某个检查规则。例如：
const foo: any[]; // tslint:disable-next-line no-any
规则
@jedmao/tslint 包提供了大量代码检查规则，这些规则可以帮助我们捕获潜在的错误，同时提供一些代码风格的建议。
以下是部分常用的规则：
array-type
该规则用来规定数组类型的使用方式。
- "array": 使用
T[]的形式； - "generic": 使用
Array<T>的形式。
例如：
{
"rules": {
"array-type": [true, "array"]
}
}ban-comma-operator
该规则禁止在运算中使用逗号表达式。例如：
{
"rules": {
"ban-comma-operator": true
}
}curly
该规则要求所有非单行语句块包含大括号。例如：
{
"rules": {
"curly": true
}
}将会检查以下代码：
if (condition)
console.log('hello world');member-access
该规则要求所有类成员的访问控制符定义。例如：
{
"rules": {
"member-access": [true, "check-accessor"]
}
}no-conditional-assignment
该规则禁止在条件中使用赋值语句。例如：
{
"rules": {
"no-conditional-assignment": true
}
}no-console
该规则禁止使用 console。例如：
{
"rules": {
"no-console": true
}
}no-unnecessary-class
该规则要求在没有成员时不要定义空类。例如：
{
"rules": {
"no-unnecessary-class": true
}
}以上是部分示例，完整规则可以查看官方文档：https://palantir.github.io/tslint/rules/
TypeScript 语言服务
当我们在编辑器中输入代码时，可以使用 TypeScript 语言服务来检查代码。TypeScript 语言服务会分析我们的代码，并通过检查规则来提供一些警告和建议。
在 VS Code 中，我们可以通过以下步骤启用 TypeScript 语言服务：
- 打开 VS Code；
- 打开项目；
- 在菜单上选择
View -> Command Palette，输入TypeScript: Select TypeScript Version，选择Use Workspace Version； - 在菜单上选择
View -> Command Palette，输入typescript: Open TS Server Log，选择Typescript: Open in Output Channel。
现在，在编辑器中输入代码时，就会显示检查错误和建议。
总结
@jedmao/tslint 是一个强大的工具，它可以帮助我们在编写 TypeScript 或 JavaScript 代码时捕获潜在的错误，并提供一些代码风格的建议。我们可以通过配置文件来定制要检查的规则和代码风格，或者在代码中使用注释临时禁止某个检查规则。
在开发过程中，我们还可以使用 TypeScript 语言服务来检查代码。TypeScript 语言服务可以通过检查规则来提供警告和建议。
最后，希望本文能对您了解 @jedmao/tslint 的使用有所帮助。如果您有任何问题或建议，请在评论区留言，谢谢！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f0575fa403f2923b035bee6