编译 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 版本。

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

tsconfig.json

通常，任何新的 TypeScript 项目的第一步都是添加一个 tsconfig.json 文件。tsconfig.json 文件定义了 TypeScript 的项目设置，例如编译器选项和应该包含的文件。要做到这一点，打开你想要存储源代码的文件夹，并添加一个名为 tsconfig.json 的新文件。进入此文件后，智能感知（IntelliSense）（⌃Space (Windows, Linux Ctrl+Space)）将一路为你提供帮助。

一个针对 ES5、CommonJS 模块和 source map 的简单 tsconfig.json 如下所示：

{
  "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 来运行它。

第 2 步：运行 TypeScript 构建

从全局**终端**菜单执行**运行生成任务**（⇧⌘B (Windows, Linux Ctrl+Shift+B)）。如果你在前面的部分创建了 tsconfig.json 文件，此时应该会出现以下选择器：

选择 **tsc: build** 条目。这将在工作区中生成一个 HelloWorld.js 和一个 HelloWorld.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**。

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

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

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

JavaScript source map 支持

TypeScript 调试支持 JavaScript source map。要为你的 TypeScript 文件生成 source map，请使用 --sourcemap 选项进行编译，或在 tsconfig.json 文件中将 sourceMap 属性设置为 true。

也支持内联 source map（内容以数据 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 文件被编译到相同位置，文件资源管理器将不再显示其派生资源。

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

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

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

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

使用较新的 TypeScript 版本

VS Code 自带一个最新的稳定版 TypeScript 语言服务，并默认使用它在你的工作区中提供智能感知。工作区使用的 TypeScript 版本与你用来编译 *.ts 文件的 TypeScript 版本是独立的。在大多数常见情况下，你可以直接使用 VS Code 内置的 TypeScript 版本进行智能感知，无需担心。但有时，你可能需要更改 VS Code 用于智能感知的 TypeScript 版本。

这样做的一些原因包括：

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

当你查看 TypeScript 文件，并从语言状态栏将版本号固定后，当前活动的 TypeScript 版本及其安装位置会显示在状态栏中。

如果你想更改工作区中默认的 TypeScript 版本，有几种选择：

使用工作区的 TypeScript 版本

如果你的工作区有特定的 TypeScript 版本，你可以在工作区版本和 VS Code 默认版本之间切换。方法是打开一个 TypeScript 或 JavaScript 文件，然后点击状态栏中的 TypeScript 版本号。此时会弹出一个消息框，询问 VS Code 应该使用哪个版本的 TypeScript：

用此功能可以在 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 install 期间指定 @version。例如，对于 TypeScript 3.6.0，你应该使用 npm install --save-dev typescript@3.6.0。要预览 TypeScript 的下一个版本，请运行 npm install --save-dev typescript@next。

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

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

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

typescript.tsdk 工作区设置只是告诉 VS Code 存在一个工作区版本的 TypeScript。要真正开始使用工作区版本进行智能感知，你必须运行**TypeScript: 选择 TypeScript 版本**命令并选择工作区版本。

使用 TypeScript 每夜构建版

在 VS Code 中试用最新 TypeScript 功能的最简单方法是安装 JavaScript and TypeScript Nightly 扩展。

此扩展会自动将 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 中使用 include 或 files，以确保项目只包含应该成为项目一部分的文件。

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

使用项目引用拆分你的项目

与其将源代码组织成一个单一的大型项目，不如使用项目引用将其分解成更小的项目来提高性能。这使得 TypeScript 每次只需加载代码库的一个子集，而不是加载全部内容。

请参阅 TypeScript 文档，了解如何使用项目引用及其最佳实践的详细信息。

后续步骤

继续阅读以了解：

• 编辑 TypeScript - TypeScript 的特定编辑功能。
• 重构 TypeScript - TypeScript 语言服务提供的有用重构。
• 调试 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 语句中的 case 穿透
• 并非所有代码路径都有返回值

将这些视为警告与其他工具（如 TSLint）的行为一致。当你从命令行运行 tsc 时，这些仍然会显示为错误。

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