Skapa ett Azure Data Studio Keymap-tillägg

Artikel
10/16/2024

Den här självstudien visar hur du skapar ett nytt Azure Data Studio-tillägg. Tillägget skapar välbekanta SSMS-nyckelbindningar i Azure Data Studio.

I den här artikeln lär du dig hur du:

Skapa ett tilläggsprojekt
Installera tilläggsgeneratorn
Skapa ditt tillägg
Lägga till anpassade nyckelbindningar i tillägget
Testa tillägget
Paketera tillägget
Publicera ditt tillägg på Marketplace

Förutsättningar

Azure Data Studio bygger på samma ramverk som Visual Studio Code, så tillägg för Azure Data Studio skapas med hjälp av Visual Studio Code. För att komma igång behöver du följande komponenter:

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.
Visual Studio Code för att felsöka tillägget.
Azure Data Studio-felsökningstillägget (valfritt). På så sätt kan du testa tillägget utan att behöva paketera och installera det i Azure Data Studio.
Se till att azuredatastudio är i din sökväg. För Windows kontrollerar du att du väljer alternativet Add to Path i setup.exe. För Mac eller Linux kör du kommandot Installera "azuredatastudio" i PATH från kommandopaletten i Azure Data Studio.

Installera tilläggsgeneratorn

För att förenkla processen med att skapa tillägg har vi skapat en tilläggsgenerator med Hjälp av Yeoman. Installera den genom att köra koden i kommandotolken nedan:

npm install -g yo generator-azuredatastudio

Skapa nyckelmappstillägget

Så här skapar du ett tillägg:

Starta tilläggsgeneratorn med följande kommando:

yo azuredatastudio
Välj Ny nyckelkarta i listan över tilläggstyper:
Följ stegen för att fylla i tilläggsnamnet (för den här självstudien använder du ssmskeymap2) och lägger till en beskrivning.

När du slutför föregående steg skapas en ny mapp. Öppna mappen i Visual Studio Code så är du redo att skapa ett eget nyckelbindningstillägg!

Lägga till ett kortkommando

Steg 1: Hitta genvägarna som ska ersättas

Nu när vårt tillägg är klart lägger du till några SSMS-kortkommandon (eller nyckelbindningar) i Azure Data Studio. Jag använde Andy Mallons Cheatsheet och RedGates kortkommandolista för inspiration.

De viktigaste saker jag såg saknas var:

Kör en fråga med den faktiska körningsplanen aktiverad. Det här är Ctrl+M i SSMS och har ingen bindning i Azure Data Studio.
Att ha CTRL+SKIFT+E som ett andra sätt att köra en fråga. Användarfeedback visade att detta saknades.
Alt +F1 körs sp_help. Vi lade till detta i Azure Data Studio, men eftersom bindningen redan användes mappade vi den till ALT+F2 i stället.
Växla helskärmsläge (SKIFT+ALT+RETUR).
F8 för att visa vyn Object Explorer-servrar / .

Det är enkelt att hitta och ersätta dessa nyckelbindningar. Kör Öppna kortkommandon för att visa fliken Kortkommandon i Azure Data Studio, sök efter frågor och välj sedan Ändra nyckelbindning. När du har ändrat nyckelbindningen kan du se den uppdaterade mappningen i filen keybindings.json (kör Öppna kortkommandon för att se den).

Kortkommandon för tangentbord

Keybindings.json tillägg

Steg 2: Lägg till genvägar till tillägget

Om du vill lägga till genvägar till tillägget öppnar du filen package.json (i tillägget) och ersätter contributes avsnittet med koden nedan:

"contributes": {
  "keybindings": [
    {
      "key": "shift+cmd+e",
      "command": "runQueryKeyboardAction"
    },
    {
      "key": "ctrl+cmd+e",
      "command": "workbench.view.explorer"
    },
    {
      "key": "alt+f1",
      "command": "workbench.action.query.shortcut1"
    },
    {
      "key": "shift+alt+enter",
      "command": "workbench.action.toggleFullScreen"
    },
    {
      "key": "f8",
      "command": "workbench.view.connections"
    },
    {
      "key": "ctrl+m",
      "command": "runCurrentQueryWithActualPlanKeyboardAction"
    }
  ]
}

Testa tillägget

Kontrollera att azuredatastudio det finns i din PATH genom att köra kommandot Installera azuredatastudio i PATH-kommandot i Azure Data Studio.

Kontrollera att Azure Data Studio Debug-tillägget är installerat i Visual Studio Code.

Välj F5 för att starta Azure Data Studio i felsökningsläge där tillägget körs:

Installera tillägget

testtillägg

Nyckelkartor är ett av de snabbaste tilläggen att skapa, så det nya tillägget bör nu fungera och vara redo att dela.

Paketera tillägget

Om du vill dela med andra måste du paketera tillägget i en enda fil. Detta kan publiceras på Azure Data Studio-tillägget Marketplace eller delas mellan ditt team eller din community. För att göra detta måste du installera ett annat npm-paket från kommandoraden:

npm install -g vsce

Gå till baskatalogen för tillägget och kör vsce package. Jag var tvungen att lägga till ett par extra linjer för att stoppa vsce-verktyget från att klaga:

"repository": {
    "type": "git",
    "url": "https://github.com/kevcunnane/ssmskeymap.git"
},
"bugs": {
    "url": "https://github.com/kevcunnane/ssmskeymap/issues"
},

När detta var klart skapades min ssmskeymap-0.1.0.vsix-fil och redo att installera och dela med världen!

Installera

Publicera ditt tillägg på Marketplace

Azure Data Studio-tillägget Marketplace är under uppbyggnad, men den aktuella processen är att vara värd för tillägget VSIX någonstans (till exempel en GitHub-versionssida) och sedan skicka en PR som uppdaterar den här JSON-filen med din tilläggsinformation.

Nästa steg

I den här självstudiekursen lärde du dig att:

Skapa ett tilläggsprojekt
Installera tilläggsgeneratorn
Skapa ditt tillägg
Lägga till anpassade nyckelbindningar i tillägget
Testa tillägget
Paketera tillägget
Publicera ditt tillägg på Marketplace

Vi hoppas att du efter att ha läst detta kommer att inspireras att skapa ett eget tillägg för Azure Data Studio. Vi har stöd för Instrumentpanelsinsikter (vackra grafer som körs mot din SQL Server), ett antal SQL-specifika API:er och en enorm befintlig uppsättning tilläggspunkter som ärvts från Visual Studio Code.

Om du har en idé men inte vet hur du kommer igång öppnar du ett problem eller tweetar i teamet: azuredatastudio.

Du kan alltid läsa tilläggsguiden för Visual Studio Code eftersom den omfattar alla befintliga API:er och mönster.

Om du vill lära dig hur du arbetar med T-SQL i Azure Data Studio slutför du självstudiekursen för T-SQL-redigeraren:

Använda Transact-SQL-redigeraren för att skapa databasobjekt

Dela via