Dela via

Utöka funktioner genom att skapa Azure Data Studio-tillägg

  • Artikel

Tillägg i Azure Data Studio är ett enkelt sätt att lägga till fler funktioner i den grundläggande Azure Data Studio-installationen.

Tillägg tillhandahålls av Azure Data Studio-teamet (Microsoft) samt communityn från tredje part (du!).

Skapa ett tillägg

Om du är intresserad av att utöka Azure Data Studio kan du skapa ett eget tillägg och publicera det i tilläggsgalleriet.

Skriva ett tillägg

Förutsättningar

För att utveckla ett tillägg behöver du Node.js installerat och tillgängligt i .$PATH Node.js innehåller npm, Node.js Package Manager, som används för att installera tilläggsgeneratorn.

Om du vill skapa ditt nya tillägg kan du använda Azure Data Studio-tilläggsgeneratorn. Yeoman-tilläggsgeneratorn är en bra utgångspunkt för tilläggsprojekt. Starta generatorn genom att ange följande kommando i en kommandotolk:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

En djupgående guide om hur du kommer igång med tilläggsmallen finns i keymap-tillägget, som vägleder dig genom skapandet av ett tillägg.

Utökningsbarhetsreferenser

Mer information om utökningsbarhet för Azure Data Studio finns i Översikt över utökningsbarhet. Du kan också se exempel på hur du använder API:et i befintliga exempel.

Felsöka ett tillägg

Du kan felsöka det nya tillägget med hjälp av Visual Studio Code-tillägget Azure Data Studio Debug.

Så här felsöker du tillägget:

  1. Öppna tillägget med Visual Studio Code.
  2. Installera Azure Data Studio Debug-tillägget.
  3. Välj F5 eller välj felsökningsikonen och välj sedan Start.
  4. En ny instans av Azure Data Studio startar i ett särskilt läge (Extension Development Host). Den här nya instansen är nu medveten om ditt tillägg.

Skapa ett tilläggspaket

När du har skrivit tillägget måste du skapa ett VSIX-paket som installeras i Azure Data Studio. Du kan använda vscode-vsce (Visual Studio Code-tillägg) för att skapa VSIX-paketet.

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

Med ett VSIX-paket kan du dela tillägget lokalt och privat genom att dela .vsix-filen och använda kommandotilläggen : Installera från VSIX-filen från kommandopaletten för att installera tillägget i Azure Data Studio.

Publicera ett tillägg

Så här publicerar du ditt nya tillägg till Azure Data Studio:

  1. Lägg till tillägget i tilläggsgalleriet.
  2. Vi har för närvarande inte stöd för att vara värd för tillägg från tredje part. I stället för att ladda ned tillägget har Azure Data Studio möjlighet att bläddra till en nedladdningssida. Om du vill ange en nedladdningssida för tillägget anger du värdet för tillgången Microsoft.AzureDataStudio.DownloadPage.
  3. Skapa en PR mot versions-/tilläggsgrenen.
  4. Skicka en granskningsbegäran till teamet.

Tillägget granskas och läggs till i tilläggsgalleriet.

Publicera tilläggsuppdateringar

Processen för att publicera uppdateringar liknar publiceringen av tillägget. Kontrollera att versionen har uppdaterats i package.json.

Nästa steg

I någon av följande självstudier för tilläggsredigering finns stegvisa instruktioner om hur du kommer igång: