现已发布!阅读关于 11 月份的新功能和修复。

编译 TypeScript

TypeScript 是 JavaScript 的类型化超集,它会被转译为纯 JavaScript。它提供了类、模块和接口来帮助你构建强大的组件。

安装 TypeScript 编译器

Visual Studio Code 包括 TypeScript 语言支持,但不包括 TypeScript 编译器 tsc。你需要全局或在你的工作区中安装 TypeScript 编译器,以便将 TypeScript 源代码转译为 JavaScript (tsc HelloWorld.ts)。

安装 TypeScript 最简单的方法是通过 npm,即 Node.js 包管理器。如果已安装 npm,你可以在你的计算机上全局 (-g) 安装 TypeScript,方法是

npm install -g typescript

你可以通过检查版本或帮助来测试你的安装。

tsc --version
tsc --help

另一种选择是在你的项目中本地安装 TypeScript 编译器 (npm install --save-dev typescript),这样可以避免与你可能有的其他 TypeScript 项目发生交互。

编译器与语言服务

请务必记住,VS Code 的 TypeScript 语言服务与你安装的 TypeScript 编译器是分开的。当你打开 TypeScript 文件时,你可以在状态栏中看到 VS Code 的 TypeScript 版本。

TypeScript version displayed in the Status Bar

在本文的后面,我们将讨论如何更改 VS Code 使用的 TypeScript 语言服务版本。

tsconfig.json

通常,任何新的 TypeScript 项目的第一步是添加一个 tsconfig.json 文件。tsconfig.json 文件定义了 TypeScript 项目设置,例如编译器选项和应包含的文件。为此,请打开你想要存储源代码的文件夹,并添加一个名为 tsconfig.json 的新文件。在此文件中,IntelliSense (⌃Space (Windows、Linux Ctrl+Space)) 将在整个过程中为你提供帮助。

tsconfig.json IntelliSense

一个简单的 tsconfig.json 文件如下所示,用于 ES5、CommonJS 模块 和源映射

{
  "compilerOptions": {
    "target": "ES5",
    "module": "CommonJS",
    "sourceMap": true
  }
}

现在,当你创建一个 .ts 文件作为项目的一部分时,我们将提供丰富的编辑体验和语法验证。

将 TypeScript 转译为 JavaScript

VS Code 通过我们集成的任务运行器tsc 集成。我们可以使用它将 .ts 文件转译为 .js 文件。使用 VS Code 任务的另一个好处是,你可以在“问题”面板中看到集成的错误和警告检测。让我们演练一下转译一个简单的 TypeScript Hello World 程序的过程。

步骤 1:创建一个简单的 TS 文件

在空文件夹上打开 VS Code,并创建一个 helloworld.ts 文件,将以下代码放入该文件中...

let message: string = 'Hello World';
console.log(message);

要测试你是否正确安装了 TypeScript 编译器 tsc 以及一个可运行的 Hello World 程序,请打开一个终端并键入 tsc helloworld.ts。你可以直接在 VS Code 中使用集成终端 (⌃` (Windows、Linux Ctrl+`))。

你现在应该会看到转译后的 helloworld.js JavaScript 文件,如果你安装了 Node.js,则可以通过键入 node helloworld.js 来运行该文件。

build and run Hello World

步骤 2:运行 TypeScript 构建

从全局的 “终端” 菜单中执行 “运行生成任务” (⇧⌘B (Windows、Linux Ctrl+Shift+B))。如果你在前面的部分中创建了 tsconfig.json 文件,则应该会显示以下选择器

TypeScript Build

选择 “tsc: build” 条目。这将在工作区中生成一个 HelloWorld.jsHelloWorld.js.map 文件。

如果你选择了 “tsc: watch”,则 TypeScript 编译器会监视你的 TypeScript 文件的更改,并在每次更改时运行转译器。

在底层,我们以任务的形式运行 TypeScript 编译器。我们使用的命令是:tsc -p .

步骤 3:将 TypeScript 构建设为默认值

你还可以将 TypeScript 构建任务定义为默认构建任务,以便在触发 “运行生成任务” (⇧⌘B (Windows、Linux Ctrl+Shift+B)) 时直接执行它。为此,请从全局 “终端” 菜单中选择 “配置默认生成任务”。这将向你显示一个包含可用构建任务的选择器。选择 TypeScript “tsc: build”,它将在 .vscode 文件夹中生成以下 tasks.json 文件

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "type": "typescript",
            "tsconfig": "tsconfig.json",
            "problemMatcher": [
                "$tsc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

请注意,该任务有一个 group JSON 对象,该对象将任务的 kind 设置为 build 并使其成为默认值。现在,当你选择 “运行生成任务” 命令或按 (⇧⌘B (Windows、Linux Ctrl+Shift+B)) 时,系统不会提示你选择任务,并且你的编译将开始。

提示: 你也可以使用 VS Code 的“运行/调试”功能来运行程序。有关在 VS Code 中运行和调试 Node.js 应用程序的详细信息,请参阅Node.js 教程

步骤 4:检查构建问题

VS Code 任务系统还可以通过问题匹配器检测构建问题。问题匹配器会根据特定的构建工具解析构建输出,并提供集成的错误显示和导航。VS Code 提供了许多问题匹配器,上面 tasks.json 中看到的 $tsc 就是用于 TypeScript 编译器输出的问题匹配器。

例如,如果我们的 TypeScript 文件中存在一个简单的错误(在 console.log 中多了一个 'g'),我们可能会从 tsc 得到以下输出:

HelloWorld.ts(3,17): error TS2339: Property 'logg' does not exist on type 'Console'.

这将在终端面板中显示(⌃` (Windows, Linux Ctrl+`)),并在终端视图下拉列表中选择 Tasks - build tsconfig.json

您可以在状态栏中看到错误和警告计数。点击错误和警告图标可获取问题列表并导航到它们。

Error in Status Bar

您还可以使用键盘打开列表 ⇧⌘M (Windows, Linux Ctrl+Shift+M)

提示:任务为许多操作提供了丰富的支持。请查看任务主题,了解有关如何配置它们的更多信息。

JavaScript 源映射支持

TypeScript 调试支持 JavaScript 源代码映射。要为您的 TypeScript 文件生成源代码映射,请使用 --sourcemap 选项进行编译,或将 tsconfig.json 文件中的 sourceMap 属性设置为 true

还支持内联源代码映射(其中内容存储为数据 URL 而不是单独的文件),尽管尚未支持内联源代码。

生成文件的输出位置

如果生成的 JavaScript 文件与 TypeScript 源代码位于同一文件夹中,则在较大的项目中会很快变得混乱。您可以使用 outDir 属性为编译器指定输出目录。

{
  "compilerOptions": {
    "target": "ES5",
    "module": "CommonJS",
    "outDir": "out"
  }
}

隐藏派生的 JavaScript 文件

当您使用 TypeScript 时,通常不希望在文件资源管理器或搜索结果中看到生成的 JavaScript 文件。VS Code 通过 files.exclude 工作区设置提供过滤功能,您可以轻松创建一个表达式来隐藏这些派生文件。

**/*.js: { "when": "$(basename).ts" }

此模式将匹配任何 JavaScript 文件(**/*.js),但前提是存在同名的兄弟 TypeScript 文件。如果 JavaScript 被编译到相同的位置,文件资源管理器将不再显示派生的 JavaScript 资源。

Hiding derived resources Hiding derived resources

在工作区 settings.json 文件中添加带有过滤器的 files.exclude 设置,该文件位于工作区根目录的 .vscode 文件夹中。您可以通过命令面板中的 首选项:打开工作区设置 (JSON) 命令打开工作区 settings.json 文件(⇧⌘P (Windows, Linux Ctrl+Shift+P))。

要排除从 .ts.tsx 源文件生成的 JavaScript 文件,请使用此表达式:

"files.exclude": {
    "**/*.js": { "when": "$(basename).ts" },
    "**/**.js": { "when": "$(basename).tsx" }
}

这是一个小技巧。搜索 glob 模式用作键。上面的设置使用两个不同的 glob 模式来提供两个唯一的键,但搜索仍会匹配相同的文件。

使用较新的 TypeScript 版本

VS Code 附带了最新稳定版本的 TypeScript 语言服务,默认情况下使用它在您的工作区中提供 IntelliSense。TypeScript 的工作区版本独立于您用于编译 *.ts 文件的 TypeScript 版本。在大多数常见情况下,您可以直接使用 VS Code 的内置 TypeScript 版本进行 IntelliSense,而无需担心,但有时您可能需要更改 VS Code 用于 IntelliSense 的 TypeScript 版本。

这样做的一些原因包括:

  • 通过切换到 TypeScript 每夜构建版本 (typescript@next) 来尝试最新的 TypeScript 功能。
  • 确保您用于 IntelliSense 的 TypeScript 版本与您用于编译代码的 TypeScript 版本相同。

当查看 TypeScript 文件时,活动 TypeScript 版本及其安装位置会显示在状态栏中。

TypeScript status bar version

如果您想更改工作区中 TypeScript 的默认版本,您有以下几种选择:

使用 TypeScript 的工作区版本

如果您的工作区具有特定的 TypeScript 版本,您可以通过打开 TypeScript 或 JavaScript 文件并点击状态栏中的 TypeScript 版本号,在 TypeScript 的工作区版本和 VS Code 默认使用的版本之间切换。将出现一个消息框,询问您 VS Code 应该使用哪个版本的 TypeScript。

TypeScript version selector

使用此方法在 VS Code 自带的 TypeScript 版本和工作区中的 TypeScript 版本之间切换。您还可以使用 TypeScript:选择 TypeScript 版本命令触发 TypeScript 版本选择器。

VS Code 将自动检测安装在工作区根目录 node_modules 下的 TypeScript 工作区版本。您还可以通过在用户或工作区 设置中配置 typescript.tsdk 来明确告诉 VS Code 使用哪个版本的 TypeScript。typescript.tsdk 设置应指向包含 TypeScript tsserver.js 文件的目录。您可以使用 npm list -g typescript 查找 TypeScript 安装位置。tsserver.js 文件通常位于 lib 文件夹中。

例如:

{
  "typescript.tsdk": "/usr/local/lib/node_modules/typescript/lib"
}

提示: 要获取特定版本的 TypeScript,请在 npm 安装期间指定 @version。例如,对于 TypeScript 3.6.0,您将使用 npm install --save-dev [email protected]。要预览下一个版本的 TypeScript,请运行 npm install --save-dev typescript@next

请注意,虽然在这些示例中 typescript.tsdk 指向 typescript 内部的 lib 目录,但 typescript 目录必须是包含 TypeScript package.json 文件的完整 TypeScript 安装。

您还可以通过添加指向 tsserver.js 文件目录的 typescript.tsdk 工作区设置来告诉 VS Code 在特定工作区中使用特定版本的 TypeScript。

{
  "typescript.tsdk": "./node_modules/typescript/lib"
}

typescript.tsdk 工作区设置仅告诉 VS Code 存在 TypeScript 的工作区版本。要实际开始使用工作区版本进行 IntelliSense,您必须运行 TypeScript:选择 TypeScript 版本命令并选择工作区版本。

使用 TypeScript 每夜构建版本

在 VS Code 中尝试最新 TypeScript 功能的最简单方法是安装JavaScript 和 TypeScript 每夜构建扩展

此扩展会自动将 VS Code 的内置 TypeScript 版本替换为最新的 TypeScript 每夜构建版本。如果您已使用 TypeScript:选择 TypeScript 版本命令配置了 TypeScript 版本,请确保切换回使用 VS Code 的 TypeScript 版本

混合 TypeScript 和 JavaScript 项目

可以混合使用 TypeScript 和 JavaScript 项目。要在 TypeScript 项目中启用 JavaScript,您可以在 tsconfig.json 中将 allowJs 属性设置为 true

提示: tsc 编译器不会自动检测 jsconfig.json 文件的存在。使用 -p 参数使 tsc 使用您的 jsconfig.json 文件,例如 tsc -p jsconfig.json

处理大型项目

如果您正在处理包含数百或数千个 TypeScript 文件的代码库,以下是一些可以采取的步骤,以改善 VS Code 中的编辑体验以及命令行上的编译时间。

确保您的 tsconfig 仅包含您关心的文件

在项目的 tsconfig.json 中使用 includefiles,以确保项目仅包含应成为项目一部分的文件。

有关配置项目的 tsconfig.json 的更多信息

使用项目引用分解您的项目

与其将源代码结构化为单个大型项目,不如使用项目引用将其分解为较小的项目,从而提高性能。这允许 TypeScript 一次仅加载代码库的子集,而不是加载整个代码库。

有关如何使用项目引用以及使用它们的最佳实践的详细信息,请参阅TypeScript 文档

后续步骤

继续阅读以了解有关以下内容的信息:

常见问题

如何解决 TypeScript "无法编译外部模块" 错误?

如果遇到该错误,请通过在项目的根文件夹中创建 tsconfig.json 文件来解决。tsconfig.json 文件允许您控制 Visual Studio Code 如何编译您的 TypeScript 代码。有关更多信息,请参阅tsconfig.json 概述

为什么我在 VS Code 中得到的错误和警告与我编译 TypeScript 项目时不同?

VS Code 附带了最新稳定版本的 TypeScript 语言服务,它可能与您的计算机上全局安装或本地安装在工作区中的 TypeScript 版本不匹配。因此,您可能会看到编译器输出与活动 TypeScript 语言服务检测到的错误之间存在差异。有关安装匹配的 TypeScript 版本的详细信息,请参阅使用较新版本的 TypeScript

我可以使用 VS 2022 附带的 TypeScript 版本吗?

不可以,Visual Studio 2019 和 2022 附带的 TypeScript 语言服务与 VS Code 不兼容。您需要从 npm 安装单独版本的 TypeScript。

为什么某些错误报告为警告?

默认情况下,VS Code TypeScript 将代码样式问题显示为警告而不是错误。这适用于:

  • 声明了变量但从未使用
  • 声明了属性但从不读取其值
  • 检测到无法访问的代码
  • 未使用的标签
  • switch 中的穿透情况
  • 并非所有代码路径都返回值

将这些视为警告与其他工具(例如 TSLint)一致。当您从命令行运行 tsc 时,它们仍将显示为错误。

您可以通过在用户设置中设置 "typescript.reportStyleChecksAsWarnings": false 来禁用此行为。