Vytvoření rozšíření Azure Data Studio Keymap

Článek
10/16/2024

V tomto kurzu se dozvíte, jak vytvořit nové rozšíření Azure Data Studio. Rozšíření vytvoří známé klíčové vazby SSMS v Nástroji Azure Data Studio.

V tomto článku získáte informace o těchto tématech:

Vytvoření projektu rozšíření
Instalace generátoru rozšíření
Vytvoření rozšíření
Přidání vlastních vazeb klíčů do rozšíření
Otestování rozšíření
Zabalení rozšíření
Publikování rozšíření na marketplace

Požadavky

Azure Data Studio je postavené na stejné platformě jako Visual Studio Code, takže rozšíření pro Azure Data Studio se sestavují pomocí editoru Visual Studio Code. Abyste mohli začít, potřebujete následující komponenty:

Node.js nainstalované a dostupné ve vašem $PATHsouboru . Node.js zahrnuje npm, Node.js Správce balíčků, který se používá k instalaci generátoru rozšíření.
Visual Studio Code pro ladění rozšíření
Rozšíření azure Data Studio Debug (volitelné) To vám umožní otestovat rozšíření bez nutnosti zabalit a nainstalovat ho do nástroje Azure Data Studio.
Ujistěte se azuredatastudio , že je ve vaší cestě. V případě Windows se ujistěte, že jste v setup.exe zvolili Add to Path možnost. Pro Mac nebo Linux spusťte příkaz Install 'azuredatastudio' v PATH z palety příkazů v Nástroji Azure Data Studio.

Instalace generátoru rozšíření

Abychom zjednodušili proces vytváření rozšíření, vytvořili jsme generátor rozšíření pomocí Yeomanu. Pokud ho chcete nainstalovat, spusťte kód na příkazovém řádku níže:

npm install -g yo generator-azuredatastudio

Vytvoření rozšíření mapy klíčů

Vytvoření rozšíření:

Spusťte generátor rozšíření pomocí následujícího příkazu:

yo azuredatastudio
V seznamu typů rozšíření zvolte Nová mapa klíčů:
Podle pokynů vyplňte název rozšíření (pro účely tohoto kurzu použijte ssmskeymap2) a přidejte popis.

Dokončením předchozích kroků se vytvoří nová složka. Otevřete složku v editoru Visual Studio Code a jste připraveni vytvořit vlastní rozšíření vazby klíčů.

Přidání klávesové zkratky

Krok 1: Vyhledání zástupců, které chcete nahradit

Teď, když je naše rozšíření připravené, přidejte do azure Data Studia některé klávesové zkratky SSMS (nebo klávesové zkratky). Použil jsem Seznam klávesových zkratek Andy Mallon a RedGate pro inspiraci.

Hlavní věci, které jsem viděl, že chybí, byly:

Spusťte dotaz s povoleným skutečným plánem provádění. Toto je Ctrl+M v SSMS a nemá vazbu v Nástroji Azure Data Studio.
Kombinace kláves CTRL+SHIFT+E jako druhého způsobu spuštění dotazu Zpětná vazba uživatele ukázala, že tato možnost chybí.
Při spuštění sp_helpALT+F1 Tento postup jsme přidali v Nástroji Azure Data Studio, ale vzhledem k tomu, že se tato vazba už používá, jsme ji namapovali na ALT+F2 .
Přepnout celou obrazovku (SHIFT+ALT+ENTER).
F8 pro zobrazení Průzkumník objektů / Servers.

Tyto klíčové vazby je snadné najít a nahradit. Spuštěním otevřených klávesových zkratek zobrazte kartu Klávesové zkratky v Nástroji Azure Data Studio, vyhledejte dotaz a zvolte Změnit vazbu kláves. Jakmile dokončíte změnu vazby kláves, můžete aktualizované mapování zobrazit v souboru keybindings.json (spuštěním otevřených klávesových zkratek ji zobrazíte).

Klávesové zkratky

rozšíření Keybindings.json

Krok 2: Přidání zástupců do rozšíření

Pokud chcete do přípony přidat zástupce, otevřete soubor package.json (v příponě) a nahraďte contributes ho následujícím kódem:

"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"
    }
  ]
}

Otestování rozšíření

Ujistěte se azuredatastudio , že je ve vaší cestě spuštěním příkazu Install azuredatastudio v příkazu PATH v nástroji Azure Data Studio.

Ujistěte se, že je v editoru Visual Studio Code nainstalované rozšíření Azure Data Studio Debug.

Výběrem klávesy F5 spusťte Azure Data Studio v režimu ladění se spuštěným rozšířením:

Instalace rozšíření

rozšíření testu

Klíčové mapy jsou jedním z nejrychlejších rozšíření, která můžete vytvořit, takže vaše nové rozšíření by teď mělo být úspěšné a připravené ke sdílení.

Zabalení rozšíření

Pokud chcete sdílet s ostatními, musíte příponu zabalit do jednoho souboru. Můžete ho publikovat na Marketplace rozšíření Azure Data Studio nebo ho můžete sdílet mezi týmem nebo komunitou. K tomu je potřeba nainstalovat z příkazového řádku další balíček npm:

npm install -g vsce

Přejděte do základního adresáře rozšíření a spusťte vsce packagepříkaz . Musel jsem přidat několik dalších řádků, aby se zastavil nástroj vsce stěžovat:

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

Jakmile to bylo hotové, můj soubor ssmskeymap-0.1.0.vsix byl vytvořen a připraven k instalaci a sdílení s světem!

Instalace

Publikování rozšíření na Marketplace

Marketplace rozšíření Azure Data Studio je ve fázi výstavby, ale aktuálním procesem je hostování rozšíření VSIX někde (například stránka verze GitHubu) a pak odešlete žádost o přijetí změn, která aktualizuje tento soubor JSON s informacemi o rozšíření.

Další kroky

V tomto kurzu jste se naučili, jak:

Vytvoření projektu rozšíření
Instalace generátoru rozšíření
Vytvoření rozšíření
Přidání vlastních vazeb klíčů do rozšíření
Otestování rozšíření
Zabalení rozšíření
Publikování rozšíření na marketplace

Doufáme, že se po přečtení tohoto článku budete inspirovat k vytvoření vlastního rozšíření pro Azure Data Studio. Podporujeme přehledy řídicích panelů (pěkné grafy, které běží na SQL Serveru), řadu rozhraní API specifických pro SQL a obrovskou existující sadu bodů rozšíření zděděných z editoru Visual Studio Code.

Pokud máte nápad, ale nevíte, jak začít, otevřete problém nebo tweet v týmu: azuredatastudio.

Vždy můžete odkazovat na průvodce rozšířením editoru Visual Studio Code, protože pokrývá všechna existující rozhraní API a vzory.

Pokud chcete zjistit, jak pracovat s T-SQL v Nástroji Azure Data Studio, dokončete kurz editoru T-SQL:

Vytvoření databázových objektů pomocí editoru Transact-SQL

Sdílet prostřednictvím