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

你的第一个扩展

在本主题中,我们将教你构建扩展的基本概念。请确保你已安装 Node.jsGit

首先,使用 YeomanVS Code 扩展生成器来搭建一个 TypeScript 或 JavaScript 项目,以便进行开发。

  • 如果你不想为了以后使用而安装 Yeoman,请运行以下命令

    npx --package yo --package generator-code -- yo code
    
  • 如果你想全局安装 Yeoman 以便重复运行它,请运行以下命令

    npm install --global yo generator-code
    
    yo code
    

对于 TypeScript 项目,请填写以下字段

# ? What type of extension do you want to create? New Extension (TypeScript)
# ? What's the name of your extension? HelloWorld
### Press <Enter> to choose default for all options below ###

# ? What's the identifier of your extension? helloworld
# ? What's the description of your extension? LEAVE BLANK
# ? Initialize a git repository? Yes
# ? Bundle the source code with webpack? No
# ? Which package manager to use? npm

# ? Do you want to open the new folder with Visual Studio Code? Open with `code`

在编辑器中,打开 src/extension.ts 并按下 F5 或从命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))运行 调试: 开始调试 命令。这将编译并在新的 扩展开发主机 窗口中运行该扩展。

在新窗口中,从命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))运行 Hello World 命令

你应该会看到 Hello World from HelloWorld! 通知弹出。成功!

如果在调试窗口中看不到 Hello World 命令,请检查 package.json 文件,并确保 engines.vscode 版本与已安装的 VS Code 版本兼容。

开发扩展

让我们更改一下消息

  1. extension.ts 中,将消息从 “Hello World from HelloWorld!” 更改为 “Hello VS Code”。
  2. 在新窗口中运行 开发者: 重新加载窗口
  3. 再次运行 Hello World 命令。

你应该会看到更新后的消息弹出。

以下是一些你可以尝试的想法

  • 在命令面板中为 Hello World 命令赋予一个新名称。
  • 贡献 另一个在信息消息中显示当前时间的命令。贡献点是在 package.json 扩展清单中进行的静态声明,用于扩展 VS Code,例如向你的扩展添加命令、菜单或快捷键。
  • vscode.window.showInformationMessage 替换为另一个 VS Code API 调用,以显示警告消息。

调试扩展

VS Code 的内置调试功能使调试扩展变得容易。通过单击行旁边的装订线来设置断点,VS Code 将会命中该断点。你可以将鼠标悬停在编辑器中的变量上,或使用左侧的 运行和调试 视图来检查变量的值。调试控制台允许你评估表达式。

你可以在 Node.js 调试主题中了解有关在 VS Code 中调试 Node.js 应用的更多信息。

下一步

在下一个主题 扩展剖析 中,我们将更仔细地查看 Hello World 示例的源代码,并解释关键概念。

你可以在以下位置找到本教程的源代码:https://github.com/microsoft/vscode-extension-samples/tree/main/helloworld-sample扩展指南 主题包含其他示例,每个示例都说明了不同的 VS Code API 或贡献点,并遵循我们 UX 指南中的建议。

使用 JavaScript

在本指南中,我们主要描述如何使用 TypeScript 开发 VS Code 扩展,因为我们相信 TypeScript 为开发 VS Code 扩展提供了最佳体验。但是,如果你更喜欢 JavaScript,你仍然可以使用 helloworld-minimal-sample 来继续学习。

用户体验指南

这也是查看我们的 UX 指南 的好时机,这样你就可以开始设计你的扩展用户界面,以遵循 VS Code 的最佳实践。