简介
最近 elgervb 发布了一个名为 tslint-config-elgervb 的 npm 包，用于编写 TypeScript 代码时实现代码规范的检查和自动修复。本文将介绍如何使用并配置这个 npm 包。
安装
首先，我们需要全局安装 tslint 和 typescript：
npm install -g tslint typescript
然后，我们可以安装 tslint-config-elgervb：
npm install --save-dev tslint-config-elgervb
配置
在工程的根目录下创建一个名为 tslint.json 的文件，并添加以下内容：
{ "extends": "tslint-config-elgervb", "rules": {} }
这里的 extends 属性指定了继承的配置文件，即 tslint-config-elgervb。rules 属性可以在这里自定义规则，关于规则的自定义可以查看 tslint 的官方文档。
使用
在终端中进入项目的根目录，输入以下命令即可检查 TypeScript 代码的规范：
tslint "src/**/*.ts"
如果你不想手动修复，可以加入 --fix 参数自动修复：
tslint --fix "src/**/*.ts"
当然，为了方便使用，我们可以在 package.json 中加入以下脚本：
{ "scripts": { "lint": "tslint \"src/**/*.ts\"", "lint:fix": "tslint --fix \"src/**/*.ts\"" } }
这样，我们就可以在终端中直接输入 npm run lint 或 npm run lint:fix 来执行了。
示例代码
接下来，我们来看一下示例代码：
class Example { public static async greet(name: string): Promise<string> { return `Hello, ${name}!`; } } Example.greet().then(console.log);
这段代码有两个问题：
- 缺少文件头部的注释。
- 不符合 async 函数的命名规范。
执行 tslint --fix 命令即可自动修复：
-- -------------------- ---- ------- --- - ---- -- -- ------- ------ -- ----- ------- - ------ ------ ----- -------------- -------- --------------- - ------ ------- ---------- - - -------------------------------------展开代码
结语
通过使用 tslint-config-elgervb，我们可以方便地检查和修复 TypeScript 代码的规范。当然，在配置规则时需要结合具体项目的需求来确定，不要一味照搬。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005590e81e8991b448d67b9
