tslint-config-chweb

Disciple 团队 TSLint 规范

使用

安装

npm i tslint-config-chweb -D

配置 tslint.json

{
  "defaultSeverity": "warning",
  "extends": ["tslint-config-chweb"],
  "linterOptions": {
    "exclude": ["node_modules/**"]
  },
  "rules": {
    "no-console": false
  }
}

规则详情

TypeScript 代码风格指南

VSCode 插件

vscode-typescript-tslint-plugin（推荐）

• 微软官方出品
• 基于 TypeScript server，支持需要 Type Info 的规则
• 更高效

缺点：

• 有时候不太稳定

vscode-tslint

• 已经过长时间使用，稳定性高

缺点：

• 不支持 Type Info 的规则
• vscode-typescript-tslint-plugin发布后，已声明被废弃，不再维护

格式化配置

prettier

1、安装 prettier-vscode 插件。

2、配置 prettier

{
  "prettier.printWidth": 120,
  "prettier.singleQuote": true,
  "prettier.tslintIntegration": true, // 支持使用 prettier-tslint 工具使用 tslint 规范来格式化代码
  "prettier.trailingComma": "all"
}

目前 prettier-tslint 还不支持格式化需要‘Type Info’的规则（如 prefer-readonly, no-unnecessary-type-assertion等）。在这个PR被处理后，将会支持。

在 .vue 中使用 prettier-tslint

目前官方的 Vetur 插件暂不支持 prettier-tslint。在此PR 被合并之前，可以先使用 Vetur 的 fork 版本 Veturing

• 插件配置

{
  "vetur.format.defaultFormatter.ts": "prettier-tslint",
  "vetur.format.defaultFormatterOptions": {
    // ... other options
    "prettier": {
      "singleQuote": true,
      "printWidth": 120,
      "trailingComma": "all"
    }
  }
}