TypeScript TSLint 插件使用教程-优快云博客

TypeScript TSLint 插件使用教程

vscode-typescript-tslint-pluginVS Code extension that provides TSLint support using the typescript-tslint-plugin项目地址:https://gitcode.com/gh_mirrors/vs/vscode-typescript-tslint-plugin

1. 项目的目录结构及介绍

vscode-typescript-tslint-plugin/
├── src/                # TypeScript 源代码目录
├── lib/                # 编译后的 JavaScript 输出目录
├── test-workspace/     # 测试工作区目录
├── .gitignore          # Git 忽略文件配置
├── .npmignore          # npm 忽略文件配置
├── .travis.yml         # Travis CI 配置文件
├── CHANGELOG.md        # 更新日志
├── LICENSE             # 许可证文件
├── README.md           # 项目说明文档
├── package-lock.json   # npm 锁定文件
├── package.json        # npm 包配置文件
├── thirdpartynotices.txt # 第三方通知文件
├── tsconfig.json       # TypeScript 编译配置文件
├── tslint.json         # TSLint 配置文件
└── yarn.lock           # Yarn 锁定文件

目录结构介绍

src/: 包含 TypeScript 源代码文件。
lib/: 包含编译后的 JavaScript 文件。
test-workspace/: 用于测试的工作区目录。
.gitignore: 指定 Git 版本控制系统忽略的文件和目录。
.npmignore: 指定 npm 发布时忽略的文件和目录。
.travis.yml: Travis CI 持续集成配置文件。
CHANGELOG.md: 记录项目的更新日志。
LICENSE: 项目的许可证文件。
README.md: 项目的说明文档。
package-lock.json: 锁定 npm 依赖的版本。
package.json: 项目的 npm 包配置文件。
thirdpartynotices.txt: 第三方通知文件。
tsconfig.json: TypeScript 编译配置文件。
tslint.json: TSLint 代码风格检查配置文件。
yarn.lock: 锁定 Yarn 依赖的版本。

2. 项目的启动文件介绍

项目的启动文件主要是 src/index.ts，这是插件的入口文件。它负责初始化和配置 TypeScript TSLint 插件。

// src/index.ts
import * as ts from 'typescript';
import * as Lint from 'tslint';
import { IConnection } from 'vscode-languageserver';
import { getProgram } from './utils';
import { TSLintPlugin } from './tslintPlugin';

export function activate(connection: IConnection, compilerOptions: ts.CompilerOptions, rootPath: string) {
    const program = getProgram(compilerOptions, rootPath);
    const plugin = new TSLintPlugin(connection, program);
    plugin.start();
}

启动文件介绍

activate 函数：负责初始化插件，创建 TypeScript 程序实例，并启动 TSLint 插件。
getProgram 函数：用于获取 TypeScript 程序实例。
TSLintPlugin 类：负责处理 TSLint 相关的逻辑。

3. 项目的配置文件介绍

`tsconfig.json`

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es5",
        "outDir": "lib",
        "rootDir": "src",
        "strict": true,
        "esModuleInterop": true,
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true
    },
    "include": [
        "src/**/*"
    ]
}

`tsconfig.json` 配置介绍

compilerOptions: TypeScript 编译选项。
- module: 指定模块系统，这里使用 commonjs。
- target: 指定编译目标，这里使用 es5。
- outDir: 指定输出目录，这里使用 lib。
- rootDir: 指定源代码目录，这里使用 src。
- strict: 启用严格模式。
- esModuleInterop: 启用 ES 模块互操作。
- skipLibCheck: 跳过库文件的类型检查。
- forceConsistentCasingInFileNames: 强制文件名大小写一致。
include: 指定包含的文件和目录，