Sdílet prostřednictvím

Vytvoření rozšíření Průvodce službou Azure Data Studio

  • Článek

Tento kurz ukazuje, jak vytvořit nové rozšíření Průvodce službou Azure Data Studio. Rozšíření přispívá k interakci s uživateli v nástroji Azure Data Studio.

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

  • Instalace generátoru rozšíření
  • Vytvoření rozšíření
  • Přidání vlastního průvodce 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 na příkazovém řádku následující příkaz:

npm install -g yo generator-azuredatastudio

Vytvoření rozšíření průvodce

Úvod do průvodců

Průvodci jsou typ uživatelského rozhraní, který obsahuje podrobné stránky, které mají uživatelé vyplnit, aby mohli provést úlohu. Mezi běžné příklady patří průvodci instalací softwaru a průvodci odstraňováním potíží. Příklad:

Průvodce dacpac

Protože průvodci jsou často užitečné při práci s daty a rozšíření funkcí nástroje Azure Data Studio, nabízí Azure Data Studio rozhraní API k vytvoření vlastních průvodců. Projdeme si, jak vygenerovat šablonu Průvodce a upravit ji tak, aby vytvořila vlastního průvodce.

Spuštění generátoru rozšíření

Vytvoření rozšíření:

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

    yo azuredatastudio

  2. V seznamu typů rozšíření zvolte Nový průvodce nebo Dialogové okno . Pak vyberte Průvodce a potom šablonu Začínáme.

  3. Podle pokynů vyplňte název rozšíření (pro účely tohoto kurzu použijte rozšíření My Test) a přidejte popis.

    Generátor rozšíření

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í průvodce.

Spuštění rozšíření

Pojďme se podívat, co nám šablona průvodce poskytuje, spuštěním rozšíření. Před spuštěním se ujistěte, že je v editoru Visual Studio Code nainstalované rozšíření Azure Data Studio Debug.

Výběrem klávesy F5 ve VS Code spusťte Azure Data Studio v režimu ladění se spuštěným rozšířením. Potom v Nástroji Azure Data Studio spusťte v novém okně příkaz Průvodce spuštěním z palety příkazů (Ctr+Shift+P). Tím se spustí výchozí průvodce, který toto rozšíření přispívá:

Šablona průvodce

Dále se podíváme, jak upravit tohoto výchozího průvodce.

Vývoj průvodce

Nejdůležitější soubory, které chcete začít s vývojem rozšíření, jsou package.json, src/main.tsa vsc-extension-quickstart.md:

  • package.json: Toto je soubor manifestu, kde je zaregistrovaný příkaz Průvodce spuštěním. Tady se také main.ts deklaruje hlavní vstupní bod programu.
  • main.ts: Obsahuje kód pro přidání prvků uživatelského rozhraní do Průvodce, jako jsou stránky, text a tlačítka.
  • vsc-extension-quickstart.md: Obsahuje technickou dokumentaci, která může být užitečnou referencí při vývoji.

Pojďme v průvodci provést změnu: přidáme 4. prázdnou stránku. Upravte src/main.ts , jak je znázorněno níže, a při spuštění průvodce by se měla zobrazit další stránka.

Hlavní průvodce Jakmile se s šablonou seznámíte, tady jsou některé další nápady, které můžete vyzkoušet:

  • Přidání tlačítka s šířkou 300 na novou stránku
  • Přidání flexibilní komponenty pro vložení tlačítka do
  • Přidejte akci na tlačítko. Například po kliknutí na tlačítko spusťte dialogové okno otevření souboru nebo otevřete editor dotazů.

Zabalení rozšíření

Pokud chcete příponu 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 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

README.md Upravte zobrazení podle svých představ, přejděte do základního adresáře rozšíření a spusťte vsce packagepříkaz . Volitelně můžete propojit úložiště s rozšířením nebo pokračovat bez tohoto úložiště. Pokud ho chcete přidat, přidejte do souboru podobný řádek package.json .

"repository": {
    "type": "git",
    "url": "https://github.com/anjalia/my-test-extension.git"
}

Po přidání těchto řádků se vytvořil soubor my-test-extension-0.0.1.vsix a byl připraven k instalaci v nástroji Azure Data Studio.

Instalace VSIX

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

Marketplace rozšíření Azure Data Studio ještě není zcela implementováno, ale aktuální proces spočívá v hostování rozšíření VSIX někde (například na stránce verze GitHubu) a odeslat žádost o přijetí změn, která aktualizuje tento soubor JSON s vašimi informacemi o rozšíření.

Další kroky

V tomto kurzu jste se naučili, jak:

  • Instalace generátoru rozšíření
  • Vytvoření rozšíření
  • Přidání vlastního průvodce 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