你的第一个扩展
在本主题中,我们将介绍构建扩展的基本概念。请确保已安装 Node.js 和 Git。
首先,使用 Yeoman 和 VS 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? Y
# ? Which bundler to use? unbundled
# ? 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))运行 Debug: Start Debugging(调试:启动调试)命令。这将编译并在一个新的扩展开发宿主窗口中运行该扩展。
在新窗口的命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))中运行 Hello World 命令。
您应该会看到 Hello World from HelloWorld! 的通知弹出。成功!
如果您在调试窗口中看不到 Hello World 命令,请检查 package.json 文件,确保 engines.vscode 版本与已安装的 VS Code 版本兼容。
开发扩展
让我们修改一下这个消息
- 在
extension.ts中,将消息从 "Hello World from HelloWorld!" 修改为 "Hello VS Code"。 - 在新窗口中运行 Developer: Reload Window(开发人员:重新加载窗口)。
- 再次运行 Hello World 命令。
您应该会看到更新后的消息弹出。
以下是一些您可以尝试的想法
- 在命令面板中为 Hello World 命令起一个新名称。
- 贡献(Contribute)另一个命令,在信息提示框中显示当前时间。贡献点(Contribution points)是您在
package.json扩展清单中进行的静态声明,用于扩展 VS Code,例如向扩展添加命令、菜单或键绑定。 - 将
vscode.window.showInformationMessage替换为另一个 VS Code API 调用,以显示警告消息。
调试扩展
VS Code 内置的调试功能使调试扩展变得简单。通过点击代码行旁边的装订线来设置断点,VS Code 将在运行到该处时中断。您可以将鼠标悬停在编辑器中的变量上,或使用左侧的 Run and Debug(运行和调试)视图来检查变量的值。调试控制台允许您评估表达式。
您可以在 Node.js 调试主题中了解有关在 VS Code 中调试 Node.js 应用的更多信息。
后续步骤
在下一个主题 扩展剖析中,我们将仔细研究 Hello World 示例的源代码并解释关键概念。
您可以在以下位置找到本教程的源代码:https://github.com/microsoft/vscode-extension-samples/tree/main/helloworld-sample。扩展指南主题包含其他示例,每个示例都演示了不同的 VS Code API 或贡献点,并遵循我们用户体验指南中的建议。
使用 JavaScript
在本指南中,我们主要介绍如何使用 TypeScript 开发 VS Code 扩展,因为我们认为 TypeScript 为开发 VS Code 扩展提供了最佳体验。但是,如果您更喜欢 JavaScript,仍然可以跟随 helloworld-minimal-sample 进行操作。
用户体验指南
现在也是查看我们用户体验指南的好时机,这样您就可以开始设计您的扩展用户界面以遵循 VS Code 的最佳实践。