npm包 @microsoft/fast-tslint-rules使用教程

简介

@microsft/fast-tslint-rules是面向TypeScript代码风格检查的npm包，它提供了一些额外的规则，使得TSLint可以支持更好的TypeScript实践，并确保代码质量更高。

安装

使用npm进行安装：

npm i @microsoft/fast-tslint-rules --save-dev

配置规则

在tslint.json配置文件中，添加fast-tslint-rules规则：

{
    "extends": ["@microsoft/fast-tslint-rules"],
    "rules": {
        "rule-name": true
    }
}

规则列表

以下是在fast-tslint-rules中常用和常见的规则列表。更多规则和详细信息请查看官方文档。

class命名

• class命名必须首字母大写，并使用驼峰命名法，用于标示类的定义

{
    "class-name": true
}

接口继承

• 接口继承使用extends关键字，而不是extends属性。
• 继承多个接口时，分别占用一行，并使用一个缩进级别从超类接口名称开始。

{
    "interface-name": true
}

文件头

• 文件头必须指定.encoding。
• <reference>声明会被省略，应该使用import导入。

{
    "file-header": true
}

实践示例

假设有以下代码，使用fast-tslint-rules进行检查和修复。

-- -------------------- ---- -------
--------- ----------- -
    --------- -------
-

----- --- ---------- ----------- -
    --------- -------

    -------------------- ------- -
        ------ --- - ---------
    -
-

运行命令检查和修复程序。

node_modules/.bin/tslint -c tslint.json -p tsconfig.json -t json src/**/*.ts --fix

程序将会自动通过eslint规则来修复代码。修复后如下：

-- -------------------- ---- -------
--------- ------------ -
    --------- -------
-

----- --- ---------- ------------ -
    --------- -------

    ------ -------------------- -------- ------ -
        ------ --- - ---------
    -
-

结尾

对于前端开发人员而言，使用良好的工具和规范可以在开发中省去许多麻烦和犯错，fast-tslint-rule就是一种好的工具，对于个人和开发团队而言都是一种不错的选择。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/microsoft-fast-tslint-rules