编译 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 模块和源映射，一个简单的 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 源映射支持

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 文件。如果派生资源被编译到同一位置，文件资源管理器将不再显示它们。

在工作区 settings.json 文件中添加带有过滤器的 files.exclude 设置，该文件位于工作区根目录的 .vscode 文件夹中。您可以通过命令面板 (⇧⌘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 语言服务，默认情况下使用它在您的工作区中提供 IntelliSense。工作区版本的 TypeScript 与您用来编译 *.ts 文件的 TypeScript 版本是独立的。在大多数常见情况下，您可以放心地只使用 VS Code 内置的 TypeScript 版本进行 IntelliSense，但有时您可能需要更改 VS Code 用于 IntelliSense 的 TypeScript 版本。

这样做的原因包括：

• 通过切换到 TypeScript nightly 版本 (typescript@next) 试用最新的 TypeScript 功能。
• 确保为 IntelliSense 使用与编译代码时相同的 TypeScript 版本。

当您通过查看 TypeScript 文件并在状态栏中固定了语言状态栏中的版本号时，活动 TypeScript 版本及其安装位置会显示在状态栏中。

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

使用工作区版本的 TypeScript

如果您的工作区有特定的 TypeScript 版本，您可以通过打开 TypeScript 或 JavaScript 文件并单击状态栏中的 TypeScript 版本号，在工作区版本的 TypeScript 和 VS Code 默认使用的版本之间进行切换。将出现一个消息框，询问 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 版本。要真正开始对 IntelliSense 使用工作区版本的 TypeScript，您必须运行 TypeScript: 选择 TypeScript 版本 命令并选择工作区版本。

使用 TypeScript nightly 版本

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

此扩展会自动将 VS Code 内置的 TypeScript 版本替换为最新的 TypeScript nightly 版本。如果您已经使用 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 语句中的 Fall through (继续执行下一个 case)
• 并非所有代码路径都返回值

将这些视为警告与 TSLint 等其他工具保持一致。当您从命令行运行 tsc 时，它们仍将显示为错误。

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