🚀 在 VS Code 中

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 项目提供 IntelliSense。

悬停信息

将鼠标悬停在 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

代码检查器

代码检查器为可疑代码提供警告。虽然 VS Code 不包含内置的 TypeScript 代码检查器,但 Marketplace 中提供了 TypeScript 代码检查器扩展

ESLint 是一种流行的代码检查器,它也支持 TypeScript。ESLint 扩展将 ESLint 集成到 VS Code 中,因此您可以在编辑器中直接查看代码检查错误,甚至可以使用快速修复快速修复其中的许多错误。ESLint 插件指南详细介绍了如何为您的 TypeScript 项目配置 ESLint。

TypeScript 扩展

VS Code 开箱即用地为 TypeScript 提供了许多功能。除了内置功能外,您还可以安装扩展程序以获得更多功能。

提示:单击上面的扩展程序磁贴以阅读描述和评论,以确定哪个扩展程序最适合您。在Marketplace中查看更多信息。

后续步骤

要了解更多信息,请参阅

常见问题

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

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

如何将最新的 TypeScript beta 与 VS Code 一起使用?

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

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