通过创建 Azure Data Studio 扩展来扩展功能

  • 项目

Azure Data Studio 中的扩展提供向基本 Azure Data Studio 安装添加更多功能的简便方法。

扩展由 Azure Data Studio 团队 (Microsoft) 以及第三方社区（你）提供。

编写扩展

如果你对扩展 Azure Data Studio 感兴趣，则可创建自己的扩展并将其发布到扩展库。

编写扩展

先决条件

若要开发扩展，你需要在 $PATH 中安装并提供 Node.js。 Node.js 包含 npm，它是用于安装扩展生成器的 Node.js 包管理器。

若要创建新的扩展，可使用 Azure Data Studio 扩展生成器。 Yeoman 扩展生成器是扩展项目的一个有用起点。 若要启动生成器，请在命令提示符处输入以下命令：

npm install -g yo generator-azuredatastudio
yo azuredatastudio

有关如何开始使用扩展模板的深入指南，请参阅键映射扩展，这将指导你完成创建扩展。

扩展性参考

若要了解 Azure Data Studio 扩展性，请参阅扩展性概述。 还可在现有示例中查看如何使用 API 的示例。

调试扩展

可使用 Visual Studio Code 扩展 Azure Data Studio 调试来调试新扩展。

若要调试扩展，请执行以下操作：

  1. 使用 Visual Studio Code 打开扩展。
  2. 安装 Azure Data Studio 调试扩展。
  3. 按 F5 或选择“调试”图标，然后选择“开始” 。
  4. Azure Data Studio 的新实例在特殊模式（扩展开发主机）下启动。 此新实例现在可以识别你的扩展。

创建扩展包

编写扩展后，需要创建 VSIX 包，以便在 Azure Data Studio 中进行安装。 可以使用 vscode-vsce（Visual Studio Code 扩展）创建 VSIX 包。

npm install -g @vscode/vsce
cd myExtensionName
vsce package
# The myExtensionName.vsix file has now been generated

借助 VSIX 包，可以通过共享 .vsix 文件并使用命令面板中的命令“Extensions:Install From VSIX File”将扩展安装到 Azure Data Studio 中，从而以本地和非公开形式共享扩展。

发布扩展

若要将新扩展发布到 Azure Data Studio，请执行以下操作：

  1. 将扩展添加到扩展库。
  2. 我们目前不支持托管第三方扩展。 Azure Data Studio 不会下载扩展，但提供了浏览到下载页面的选项。 若要为扩展设置下载页，请设置资产“Microsoft.AzureDataStudio.DownloadPage”的值。
  3. 针对发布/扩展分支创建 PR。
  4. 向团队发送评审请求。

你的扩展将接受评审并添加到扩展库中。

发布扩展更新

发布更新的过程与发布扩展的过程类似。 请确保在 package.json 中更新版本。

后续步骤

有关如何入门的分步说明，请参阅以下扩展创作教程之一：