参加你附近的 ,了解 VS Code 中的 AI 辅助开发。

Visual Studio Code 中的 TypeScript

TypeScript 是 JavaScript 的一个类型化超集,可以编译为纯 JavaScript。它提供了类、模块和接口,可以帮助你构建健壮的组件。

Working with TypeScript in Visual Studio Code

安装 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

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

Hello World

让我们从一个简单的 Hello World Node.js 示例开始。创建一个新文件夹 HelloWorld 并启动 VS Code。

mkdir HelloWorld
cd HelloWorld
code .

在文件资源管理器中,创建一个名为 helloworld.ts 的新文件。

create new file

现在添加以下 TypeScript 代码。你会注意到 TypeScript 的关键字 letstring 类型声明。

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

要编译你的 TypeScript 代码,你可以打开集成终端 (⌃` (Windows、Linux 为 Ctrl+`)) 并输入 tsc helloworld.ts。这会编译并创建一个新的 helloworld.js JavaScript 文件。

compiled hello world

如果你已安装 Node.js,可以运行 node helloworld.js

run hello world

如果你打开 helloworld.js,你会发现它与 helloworld.ts 并没有太大区别。类型信息已被移除,let 变成了 var

var message = 'Hello World';
console.log(message);

IntelliSense

智能感知(IntelliSense)为你提供智能代码补全、悬停信息和签名帮助,让你能够更快速、更准确地编写代码。

TypeScript small completions for String type

VS Code 为单个 TypeScript 文件以及 TypeScript tsconfig.json 项目提供智能感知。

悬停信息

将鼠标悬停在 TypeScript 符号上,可以快速查看其类型信息和相关文档

Hover for a lodash function

你也可以使用键盘快捷键 ⌘K ⌘I (Windows、Linux 为 Ctrl+K Ctrl+I) 在当前光标位置显示悬停信息。

签名帮助

当你编写 TypeScript 函数调用时,VS Code 会显示有关函数签名的信息,并高亮你当前正在补全的参数

Signature help for the lodash capitalize function

当你在函数调用中输入 (, 时,签名帮助会自动显示。使用 ⇧⌘Space (Windows、Linux 为 Ctrl+Shift+Space) 手动触发签名帮助。

代码片段

除了智能代码补全外,VS Code 还包含基本的 TypeScript 代码片段,在你输入时会提供建议。

TypeScript 'for' snippet suggestions

你可以安装扩展以获取更多代码片段,或为 TypeScript 定义自己的代码片段。有关更多信息,请参阅用户自定义代码片段

提示:你可以在设置文件中将 editor.snippetSuggestions 设置为 "none" 来禁用代码片段。如果你希望看到代码片段,可以指定其相对于建议的顺序:在顶部 ("top")、在底部 ("bottom") 或按字母顺序内联排序 ("inline")。默认值为 "inline"

错误和警告

TypeScript 语言服务会分析你的程序中的编码问题,并报告错误和警告

  • 在状态栏中,有所有错误和警告数量的摘要。
  • 你可以点击摘要或按 ⇧⌘M (Windows、Linux 为 Ctrl+Shift+M) 来显示包含所有当前错误列表的问题面板。
  • 如果你打开一个有错误或警告的文件,它们将以内联方式显示在文本中和概览标尺中。

Error in the editor and Problems panel

要遍历当前文件中的错误或警告,你可以按 F8⇧F8 (Windows、Linux 为 Shift+F8),这会显示一个内联区域,详细说明问题和可能的代码操作(如果可用)

Error inline in the editor

代码导航

代码导航让你能够快速浏览 TypeScript 项目。

  • 转到定义 F12 - 转到符号定义的源代码。
  • 速览定义 ⌥F12 (Windows 为 Alt+F12,Linux 为 Ctrl+Shift+F10) - 弹出一个速览窗口,显示符号的定义。
  • 转到引用 ⇧F12 (Windows、Linux 为 Shift+F12) - 显示符号的所有引用。
  • 转到类型定义 - 转到定义符号的类型。对于类的实例,这将显示类本身,而不是实例的定义位置。
  • 转到实现 ⌘F12 (Windows、Linux 为 Ctrl+F12) - 转到接口或抽象方法的实现。

您可以通过命令面板 (⇧⌘P (Windows、Linux 为 Ctrl+Shift+P)) 中的转到符号命令来进行符号搜索导航。

  • 转到文件中的符号 ⇧⌘O (Windows、Linux 为 Ctrl+Shift+O)
  • 转到工作区中的符号 ⌘T (Windows、Linux 为 Ctrl+T)

格式化

VS Code 包含一个 TypeScript 格式化程序,它提供了具有合理默认值的基本代码格式化功能。

使用 typescript.format.* 设置来配置内置格式化程序,例如让大括号出现在独立的一行。或者,如果内置格式化程序影响了你的工作,将 "typescript.format.enable" 设置为 false 以禁用它。

对于更特殊的代码格式化风格,可以尝试从 VS Code Marketplace 安装一个格式化扩展。

重构

VS Code 为 TypeScript 包含了一些方便的重构功能,例如提取函数提取常量。只需选择你想要提取的源代码,然后点击侧边栏中的灯泡图标或按 (⌘. (Windows、Linux 为 Ctrl+.)) 查看可用的重构。

TypeScript refactoring

请参阅重构 TypeScript以获取有关重构的更多信息,以及如何为各个重构配置键盘快捷键。

重命名

最简单的重构之一是重命名方法或变量。按 F2 在你的 TypeScript 项目中重命名光标下的符号

Renaming a method

调试

VS Code 对 TypeScript 提供了强大的调试支持,包括对 sourcemap 的支持。可以设置断点、检查对象、浏览调用堆栈并在调试控制台中执行代码。请参阅调试 TypeScript调试总主题以了解更多信息。

调试客户端

你可以使用浏览器调试器来调试你的客户端代码,例如内置的 Edge 和 Chrome 调试器,或者 Debugger for Firefox

调试服务器端

使用内置调试器在 VS Code 中调试 Node.js。设置很简单,并且有一篇Node.js 调试教程可以帮助你。

debug data inspection

Linter

Linter 会对可疑代码提供警告。虽然 VS Code 没有内置的 TypeScript linter,但 Marketplace 中有 TypeScript linter 扩展

ESLint 是一个流行的 linter,它也支持 TypeScript。ESLint 扩展将 ESLint 集成到 VS Code 中,这样你就可以直接在编辑器中看到 linting 错误,甚至可以通过快速修复快速修复其中许多错误。ESLint 插件指南详细介绍了如何为你的 TypeScript 项目配置 ESLint。

TypeScript 扩展

VS Code 为 TypeScript 提供了许多开箱即用的功能。除了内置功能外,你还可以安装扩展以获得更强大的功能。

提示:点击上面的扩展磁贴,阅读描述和评论,以决定哪个扩展最适合你。在 Marketplace 中查看更多。

后续步骤

要了解更多,请参阅

常见问题

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

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

如何在 VS Code 中使用最新的 TypeScript beta 版本?

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

你也可以配置 VS Code 使用特定的 TypeScript 版本