npm 包 tslint-config-ktsn 使用教程

什么是 tslint-config-ktsn？

tslint-config-ktsn 是一款 npm 包，它是一份可共享的 TypeScript 代码 lint 配置。这个配置的目标是为了强制执行作者指南的规则，对你的 TypeScript 代码进行一些自动化的检测和检查，以提高代码质量和加强可读性。

tslint-config-ktsn 基于 tslint 这个 npm 包，并且在其基础上进行了一些优化和扩展以适配作者指南。tslint 本身功能十分强大，可以自定义配置，tslint-config-ktsn 旨在把这些配置自动整合成一个通用标准，进行快速集成。

如何使用 tslint-config-ktsn？

tslint-config-ktsn 可以作为项目的 devDependencies 安装在本地，或者作为全局工具链的一部分 install 到全局系统中。安装完成后，你需要进行如下配置：

局部配置

1. 首先，使用 NPM 安装 tslint-config-ktsn：

npm install --save-dev tslint-config-ktsn

1. 接着，在工程根目录新建一个名为 tslint.json 的文件：

{
  "extends": "tslint-config-ktsn"
}

1. 最后执行检查操作：

tslint **/*.ts

全局配置

1. 首先，使用 NPM 安装 tslint、typescript 和 tslint-config-ktsn：

npm install -g tslint typescript tslint-config-ktsn

1. 接着，配置一个 tslint.json 文件。在命令行中输入：

tslint --init

选择以下配置参数：

• 使用 default linting rules（Y）
• 使用 prettier 风格的输出（Y）
• 保存配置到 tslint.json 文件中（Y）
• 为 ESLint 兼容输出更新（N）

1. 找到 tslint.json 文件，修改 extends 参数如下：

{
  "extends": "tslint-config-ktsn"
}

使用示例

不推荐的写法

 class ExampleClass {
    constructor (private name: string, private age: number){}

    public getName(): string {
        return this.name;
    }
} 

在检查中，这个代码片段将会被识别出来，提示：

11:7 - Member access on `name` outside of constructor.
11:18 - Member access on `age` outside of constructor.

推荐的写法

 class ExampleClass {
    constructor (private _name: string, private _age: number){}

    public getName(): string {
        return this._name;
    }
} 

在检查中，这个代码片段将会是正确的。通过这个例子可以看出 tslint-config-ktsn 的作用，它能检查出 TypeScript 代码中的一些使用约定和规范，从而优化代码风格。

总结

tslint-config-ktsn 并不是一个能够优化模块质量、增加性能或者强化安全的利器，但它可以提高代码质量，增加可读性，帮助你写出更好的代码。虽然配置和使用方法都非常简单，但为了大家能更好地使用它，你需要多读官方文档，进一步理解 tslint-config-ktsn 的用法和作用。

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