npm 包 tslint-config-egg 使用教程

前言

在进行前端代码开发时，我们都知道代码规范的重要性。代码规范不仅可以让代码更易于维护，也能够方便代码的重用。而在 TypeScript 项目中，使用tslint可以极大地简化代码规范的管理。

在 EGG.js 项目中，我们可以使用tslint-config-egg进行代码规范的管理。它是一个对 EGG.js 项目的开发过程进行规范化的配置文件，在使用过程中将会大大减少代码规范管理的成本。

安装

在使用前，需要先安装 npm 包 tslint-config-egg 以及它的一些依赖包。可以通过以下命令进行安装：

$ npm i -D tslint tslint-config-egg

配置

在项目中，我们可以通过在 tslint.json 中配置使用 tslint-config-egg 规范。

在 .tslint.json 中，我们可以继承 tslint-config-egg 配置，如下：

{
  "extends": ["tslint-config-egg"]
}

需要注意的是，我们可以通过在 extends 中添加其他的配置文件来进行覆盖默认的配置。

另外，tslint-config-egg 还提供了 other 和 contrib 两个配置文件用来覆盖默认的配置，比如要添加其他的语言的规范可以使用 other 文件。

规范

tslint-config-egg 提供了多条规范，这里仅列举其中的一些：

• tslint:disable:console - 禁止使用 console
• tslint:prefer-for-of - 使用 for-of 循环代替 for 循环
• tslint:radix - 在 parseInt 中必须指定基数
• tslint:no-unnecessary-type-assertion - 禁止无用的类型断言
• tslint:triple-equals - 使用 === 和 !== 代替 == 和 !=

下面我们举一个实际的例子来演示如何使用这些规范。

假设我们有一个简单的 TypeScript 代码示例，代码如下：

const compare = function(a: number, b: number) {
  if(a == b) {
      console.log('相等');
  } else {
      console.log('不相等');
  }
};

在这段代码中，我们使用了 == 符号来进行比较。而我们知道，使用 == 进行比较容易出错，导致代码运行不稳定。因此，我们应该使用 === 来进行比较。我们可以通过实现 tslint:triple-equals 规范来自动替换代码中的 == 符号。

{
  "extends": ["tslint-config-egg"],
  "rules": {
    "triple-equals": true
  }
}

在添加了这个规范之后，我们再次运行代码，就会自动地把 == 符号替换成 ===。

总结

tslint-config-egg 是一个非常好用的规范包，在 EGG.js 项目中使用效果更佳。通过本文，我们可以对 tslint-config-egg 在项目中的使用有了更深的了解，希望可以帮助读者更好地管理项目的代码规范。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f0bf02e403f2923b035c11c