Étendre les fonctionnalités en créant des extensions Azure Data Studio

Article
10/19/2023

Les extensions dans Azure Data Studio offrent un moyen simple d’ajouter des fonctionnalités à l'installation d’Azure Data Studio de base.

Les extensions sont fournies par l’équipe Azure Data Studio (Microsoft), ainsi que par la communauté tierce (vous !).

Créer une extension

Si vous souhaitez étendre Azure Data Studio, vous pouvez créer votre propre extension et la publier dans la galerie d’extensions.

Écrire une extension

Prérequis

Pour développer une extension, Node.js doit être installé et disponible dans votre $PATH. Node. js comprend npm, le gestionnaire de packages Node.js, qui est utilisé pour installer le générateur d’extensions.

Pour créer une extension, vous pouvez utiliser le générateur d’extensions Azure Data Studio. Le générateur d’extensions Yeoman est un bon point de départ pour les projets d’extension. Pour démarrer le générateur, entrez alors la commande suivante depuis l’invite de commandes :

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Pour obtenir un guide détaillé expliquant comment bien démarrer avec votre modèle d’extension, consultez l’article extension de mappage de touches, qui vous guide tout au long de la création d’une extension.

Références d’extensibilité

Pour en savoir plus sur l’extensibilité d’Azure Data Studio, consultez Vue d’ensemble de l’extensibilité. Vous pouvez également voir des exemples d’utilisation de l’API dans des exemples existants.

Déboguer une extension

Vous pouvez déboguer votre nouvelle extension à l’aide de l’extension Visual Studio Code Azure Data Studio Debug.

Pour déboguer votre extension :

Ouvrez votre extension avec Visual Studio Code.
Installez l’extension Azure Data Studio Debug.
Appuyez sur F5 ou sélectionnez l’icône Déboguer, puis sélectionnez Démarrer.
Une nouvelle instance d’Azure Data Studio démarre en mode spécial (hôte de développement d’extension). Cette nouvelle instance est désormais consciente de votre extension.

Créer un package d’extension

Après avoir écrit votre extension, vous devez créer un package VSIX pour l’installer dans Azure Data Studio. Vous pouvez utiliser vscode-vsce (Extensions Visual Studio Code) pour créer le package VSIX.

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

Avec un package VSIX, vous pouvez partager votre extension localement et en privé en partageant le fichier .vsix et en utilisant la commande Extensions : Installez à partir du fichier VSIX à partir de la palette de commandes pour installer l’extension dans Azure Data Studio.

Publier une extension

Pour publier votre nouvelle extension sur Azure Data Studio :

Ajoutez vote extension à la galerie d’extensions.
Actuellement, nous ne prenons pas en charge les extensions tierces des hôtes. Au lieu de télécharger l’extension, Azure Data Studio a la possibilité d’accéder à une page de téléchargement. Pour définir une page de téléchargement pour votre extension, définissez la valeur de la ressource Microsoft.AzureDataStudio.DownloadPage.
Créez une demande de tirage (pull request) sur une branche release/extensions.
Envoyez une demande de révision à l’équipe.

Votre extension sera revue et ajoutée à la galerie d’extensions.

Publier des mises à jour d’extension

Le processus de publication de mises à jour est similaire à la publication de l’extension. Vérifiez que la version est mise à jour dans package.json.

Étapes suivantes

Pour obtenir des instructions pas à pas afin de bien démarrer, consultez à un des tutoriels de création d’extensions suivants :

Partager via