Share via

Functionaliteit uitbreiden door Azure Data Studio-extensies te maken

  • Artikel

Extensies in Azure Data Studio bieden een eenvoudige manier om meer functionaliteit toe te voegen aan de basisinstallatie van Azure Data Studio.

Extensies worden geleverd door het Azure Data Studio-team (Microsoft), evenals de community van derden (u!).

Een extensie maken

Als u Azure Data Studio wilt uitbreiden, kunt u uw eigen extensie maken en publiceren naar de galerie met extensies.

Een extensie schrijven

Vereisten

Als u een extensie wilt ontwikkelen, moet u Node.js geïnstalleerd en beschikbaar zijn in uw $PATH. Node.js bevat npm, de Node.js Pakketbeheer, die wordt gebruikt om de extensiegenerator te installeren.

Als u uw nieuwe extensie wilt maken, kunt u de Azure Data Studio-extensiegenerator gebruiken. De Yeoman-extensiegenerator is een gunstig uitgangspunt voor uitbreidingsprojecten. Voer de volgende opdracht in een opdrachtprompt in om de generator te starten:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Voor een uitgebreide handleiding over hoe u aan de slag gaat met uw extensiesjabloon, raadpleegt u de keymap-extensie, die u begeleidt bij het maken van een extensie.

Uitbreidbaarheidsverwijzingen

Zie het overzicht van uitbreidbaarheid van Azure Data Studio voor meer informatie over de uitbreidbaarheid van Azure. U kunt ook voorbeelden zien van het gebruik van de API in bestaande voorbeelden.

Fouten opsporen in een extensie

U kunt fouten opsporen in uw nieuwe extensie met behulp van de Visual Studio Code-extensie Azure Data Studio Debug.

Fouten opsporen in uw extensie:

  1. Open uw extensie met Visual Studio Code.
  2. Installeer de Azure Data Studio Debug-extensie.
  3. Selecteer F5 of selecteer het pictogram Foutopsporing en selecteer vervolgens Start.
  4. Een nieuw exemplaar van Azure Data Studio wordt gestart in een speciale modus (Extensieontwikkelingshost). Dit nieuwe exemplaar is nu op de hoogte van uw extensie.

Een uitbreidingspakket maken

Nadat u de extensie hebt geschreven, moet u een VSIX-pakket maken dat in Azure Data Studio wordt geïnstalleerd. U kunt vscode-vsce (Visual Studio Code Extensions) gebruiken om het VSIX-pakket te maken.

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

Met een VSIX-pakket kunt u uw extensie lokaal en privé delen door het VSIX-bestand te delen en de opdrachtExtensies te gebruiken: Installeren vanuit VSIX-bestand vanuit het opdrachtpalet om de extensie in Azure Data Studio te installeren.

Een extensie publiceren

Uw nieuwe extensie publiceren naar Azure Data Studio:

  1. Voeg uw extensie toe aan de extensiesgalerie.
  2. We hebben momenteel geen ondersteuning voor het hosten van extensies van derden. In plaats van de extensie te downloaden, heeft Azure Data Studio de mogelijkheid om naar een downloadpagina te bladeren. Als u een downloadpagina voor uw extensie wilt instellen, stelt u de waarde van de asset Microsoft.AzureDataStudio.DownloadPage in.
  3. Maak een pull-aanvraag voor release-/extensiesvertakking.
  4. Stuur een beoordelingsaanvraag naar het team.

Uw extensie wordt gecontroleerd en toegevoegd aan de extensiesgalerie.

Extensie-updates publiceren

Het proces voor het publiceren van updates is vergelijkbaar met het publiceren van de extensie. Zorg ervoor dat de versie is bijgewerkt in package.json.

Volgende stappen

Zie een van de volgende zelfstudies voor het ontwerpen van extensies voor stapsgewijze instructies voor het aan de slag gaan: