Extensión de la funcionalidad mediante la creación de extensiones de Azure Data Studio

  • Artículo

Las extensiones de Azure Data Studio proporcionan una manera sencilla de agregar más funcionalidad a la instalación base de Azure Data Studio.

Las extensiones las proporciona el equipo de Azure Data Studio (Microsoft), así como la comunidad de terceros (los usuarios).

Creación de una extensión

Si está interesado en las extensiones de Azure Data Studio, puede crear su propia extensión y publicarla en la galería de extensiones.

Escritura de una extensión

Prerrequisitos

Para desarrollar una extensión ha de tener Node.js instalado y disponible en $PATH. Node.js incluye npm, el administrador de paquetes de Node.js, que se usa para instalar el generador de extensiones.

Para crear la extensión, puede usar el generador de extensiones de Azure Data Studio. El generador de extensiones de Yeoman es un punto de partida beneficioso para los proyectos de extensión. Para iniciar el generador, escriba el siguiente comando en un símbolo del sistema:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Para obtener instrucciones detalladas sobre cómo empezar a usar la plantilla de extensiones, consulte Extensión de asignación de teclado, que le guía durante la creación de una extensión.

Referencias de extensibilidad

Para más información sobre la extensibilidad de Azure Data Studio, consulte el artículo sobre introducción a la extensibilidad. También puede ver ejemplos de uso de la API en ejemplos existentes.

Depuración de una extensión

Puede depurar la nueva extensión mediante la extensión Debug de Azure Data Studio de Visual Studio Code.

Para depurar la extensión:

  1. Abra la extensión con Visual Studio Code.
  2. Instale la extensión Debug de Azure Data Studio.
  3. Seleccione F5 o seleccione el icono Depurar y, a continuación, seleccione Iniciar.
  4. Se inicia una nueva instancia de Azure Data Studio en un modo especial (Host de desarrollo de la extensión). Esta nueva instancia tiene ahora en cuenta la extensión.

Creación de un paquete de extensión

Después de escribir la extensión, debe crear un paquete VSIX para poder instalarlo en Azure Data Studio. Puede usar vscode-vsce (extensiones de Visual Studio Code) para crear el paquete VSIX.

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

Con un paquete VSIX, puede compartir la extensión de forma local y privada si comparte el archivo .vsix y usa el comando Extensiones: Instalar desde archivo VSIX de la paleta de comandos con el fin de instalar la extensión en Azure Data Studio.

Publicación de una extensión

Para publicar la nueva extensión en Azure Data Studio:

  1. Agregue la extensión a la galería de extensiones.
  2. Actualmente no se admite el hospedaje de extensiones de terceros. En lugar de descargar la extensión, Azure Data Studio tiene la opción de ir a una página de descarga. Para establecer una página de descarga para la extensión, establezca el valor del recurso Microsoft.AzureDataStudio.DownloadPage.
  3. Cree una solicitud de incorporación de cambios en la rama de versión/extensiones.
  4. Envíe una solicitud de revisión al equipo.

La extensión se revisará y se agregará a la galería de extensiones.

Publicación de actualizaciones de extensión

El proceso de publicación de actualizaciones es similar al de publicación de una extensión. Asegúrese de que la versión está actualizada en package.json.

Pasos siguientes

Consulte uno de los siguientes tutoriales sobre creación de extensiones para obtener instrucciones paso a paso sobre cómo empezar: