Estendere le funzionalità creando estensioni per Azure Data Studio

  • Articolo

Le estensioni di Azure Data Studio consentono di aggiungere facilmente nuove funzionalità all'installazione di base di questo strumento.

Le estensioni vengono fornite sia dal team di Azure Data Studio (Microsoft) sia dalla community di terze parti.

Creare un'estensione

Se si è interessati a estendere Azure Data Studio, è possibile creare un'estensione personalizzata e pubblicarla nella raccolta di estensioni.

Scrivere un'estensione

Prerequisiti

Per sviluppare un'estensione, è necessario che Node.js sia installato e disponibile in $PATH. Node.js include npm, lo strumento di gestione dei pacchetti di Node.js, che viene usato per installare il generatore di estensioni.

Per creare la nuova estensione, è possibile usare il generatore di estensioni di Azure Data Studio. Il generatore di estensioni Yeoman è un utile punto di partenza per i progetti di estensioni. Per avviare il generatore, immettere il comando seguente in un prompt dei comandi:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Per informazioni approfondite su come iniziare a usare il modello di estensione, vedere Estensione della mappatura tastiera, che illustra la creazione di un'estensione.

Informazioni di riferimento sull'estendibilità

Per informazioni sull'estendibilità di Azure Data Studio, vedere Panoramica dell'estendibilità. È anche possibile vedere esempi di come usare l'API negli esempi esistenti.

Eseguire il debug di un'estensione

È possibile eseguire il debug della nuova estensione usando l'estensione Azure Data Studio Debug di Visual Studio Code.

Per eseguire il debug dell'estensione:

  1. Aprire l'estensione con Visual Studio Code.
  2. Installare l'estensione Azure Data Studio Debug.
  3. Premere F5 oppure selezionare l'icona Debug e quindi selezionare Avvia.
  4. Una nuova istanza di Azure Data Studio viene avviata in una modalità speciale (host di sviluppo estensione). Questa nuova istanza è ora in grado di riconoscere l'estensione.

Creare un pacchetto di estensioni

Dopo aver scritto l'estensione, è necessario creare un pacchetto VSIX installabile in Azure Data Studio. È possibile usare vscode-vsce (Visual Studio Code Extension) per creare il pacchetto VSIX.

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

Con un pacchetto VSIX, è possibile condividere l'estensione in locale e privatamente condividendo il file vsix e usando il comando Estensioni: Installa da file VSIX dal riquadro comandi per installare l'estensione in Azure Data Studio.With a VSIX package, you can share your extension local and privately by sharing the .vsix file and using the command Extensions: Install From VSIX File from the command palette to install the extension in Azure Data Studio.

Pubblicare un'estensione

Per pubblicare la nuova estensione in Azure Data Studio:

  1. Aggiungere l'estensione alla raccolta di estensioni.
  2. Attualmente non è disponibile il supporto per ospitare estensioni di terze parti. Anziché scaricare l'estensione, Azure Data Studio consente di passare a una pagina di download. Per impostare una pagina di download per l'estensione, impostare il valore di asset Microsoft.AzureDataStudio.DownloadPage.
  3. Creare una richiesta pull per il ramo Release/Extensions.
  4. Inviare una richiesta di revisione al team.

L'estensione verrà verificata e aggiunta alla raccolta di estensioni.

Pubblicare gli aggiornamenti delle estensioni

Il processo di pubblicazione degli aggiornamenti è simile alla pubblicazione dell'estensione. Assicurarsi che la versione sia aggiornata in package.json.

Passaggi successivi

Per istruzioni dettagliate su come iniziare, vedere una delle esercitazioni seguenti sulla creazione di estensioni: