Erweitern der Funktionalität durch Erstellen von Erweiterungen für Azure Data Studio

  • Artikel

Erweiterungen in Azure Data Studio bieten eine einfache Möglichkeit, der Basisinstallation von Azure Data Studio weitere Funktionen hinzuzufügen.

Erweiterungen werden vom Azure Data Studio-Team (Microsoft) sowie von der Drittanbietercommunity (Ihnen!) bereitgestellt.

Erstellen einer Erweiterung

Wenn Sie Azure Data Studio erweitern möchten, können Sie eine eigene Erweiterung erstellen und im Erweiterungskatalog veröffentlichen.

Erstellen einer Erweiterung

Voraussetzungen

Zum Entwickeln einer Erweiterung muss Node.js in Ihrem $PATH installiert und verfügbar sein. Node.js enthält npm, den Node.js-Paket-Manager, der zum Installieren des Erweiterungsgenerators verwendet wird.

Zum Erstellen der neuen Erweiterung können Sie den Erweiterungs-Generator für Azure Data Studio verwenden. Der Erweiterungs-Generator von Yeoman ist ein guter Ausgangspunkt für Erweiterungsprojekte. Geben Sie den folgenden Befehl in eine Eingabeaufforderung ein, um den Generator zu starten:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Ausführliche Anleitungen zu den ersten Schritten mit Ihrer Erweiterungsvorlage finden Sie unter keymap-Erweiterung. Dort erhalten Sie schrittweise Anleitungen zum Erstellen einer Erweiterung.

Referenzen zur Erweiterbarkeit

Weitere Informationen zur Erweiterbarkeit von Azure Data Studio finden Sie in der Erweiterbarkeitsübersicht. Hier finden Sie auch Beispiele für die Verwendung der API.

Debuggen einer Erweiterung

Sie können die neue Erweiterung mithilfe der Visual Studio Code-Erweiterung Azure Data Studio Debug debuggen.

So debuggen Sie die Erweiterung:

  1. Öffnen Sie Ihre Erweiterung mit Visual Studio Code.
  2. Installieren Sie die Azure Data Studio-Debug-Erweiterung.
  3. Drücken Sie F5, oder wählen Sie das Debugsymbol aus, und klicken Sie dann auf Starten.
  4. Eine neue Instanz von Azure Data Studio wird in einem speziellen Modus (Extension Development Host, Erweiterungsentwicklungshost) gestartet. Diese neue Instanz erkennt nun Ihre Erweiterung.

Erstellen eines Erweiterungspakets

Nachdem Sie Ihre Erweiterung geschrieben haben, müssen Sie ein VSIX-Paket erstellen, das in Azure Data Studio installiert wird. Sie können vscode-vsce (Visual Studio Code-Erweiterungen) zum Erstellen des VSIX-Pakets verwenden.

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

Mit einem VSIX-Paket können Sie Ihre Erweiterung lokal und privat freigeben, indem Sie die VSIX-Datei freigeben und den Befehl Extensions: Install From VSIX File (Erweiterungen: Aus VSIX-Datei installieren) aus der Befehlspalette ausführen, um die Erweiterung in Azure Data Studio zu installieren.

Veröffentlichen einer Erweiterung

So veröffentlichen Sie die neue Erweiterung in Azure Data Studio:

  1. Fügen Sie dem Erweiterungskatalog Ihre Erweiterung hinzu.
  2. Derzeit werden keine Drittanbietererweiterungen unterstützt. Anstatt die Erweiterung herunterzuladen, bietet Azure Data Studio die Option, eine Downloadseite aufzurufen. Zum Festlegen einer Downloadseite für Ihre Erweiterung müssen Sie den Wert der Ressource Microsoft.AzureDataStudio.DownloadPage festlegen.
  3. Erstellen Sie einen Pull Request für den release/extensions-Branch.
  4. Senden Sie eine Überprüfungsanforderung an das Team.

Ihre Erweiterung wird überprüft und dem Erweiterungskatalog hinzugefügt.

Veröffentlichen von Updates für Erweiterungen

Der Prozess zum Veröffentlichen von Updates entspricht der Veröffentlichung der Erweiterung. Stellen Sie sicher, dass die Version in „package.json“ aktualisiert wird.

Nächste Schritte

In den folgenden Tutorials zum Entwickeln von Erweiterungen finden Sie ausführliche Informationen zum Einstieg: