Extensión de la funcionalidad mediante la creación de extensiones de Azure Data StudioExtend the functionality by creating Azure Data Studio extensions

Las extensiones de Azure Data StudioAzure Data Studio proporcionan una manera sencilla de agregar más funcionalidad a la instalación base de Azure Data StudioAzure Data Studio.Extensions in Azure Data StudioAzure Data Studio provide an easy way to add more functionality to the base Azure Data StudioAzure Data Studio installation.

Las extensiones las proporciona el equipo de Azure Data Studio (Microsoft), así como la comunidad (los usuarios).Extensions are provided by the Azure Data Studio team (Microsoft), as well as the 3rd party community (you!).

Creación de una extensiónAuthor an extension

Si está interesado en las extensiones de Azure Data Studio, puede crear su propia extensión y publicarla en la galería de extensiones.If you're interested in extending Azure Data Studio, you can create your own extension and publish it to the extension gallery.

Escritura de una extensiónWriting an Extension

Requisitos previosPrerequisites

Para desarrollar una extensión ha de tener Node.js instalado y disponible en la variable $PATH.To develop an extension you need Node.js installed and available in your $PATH. Node.js incluye npm, el administrador de paquetes de Node.js, que se usará para instalar el generador de extensiones.Node.js includes npm, the Node.js Package Manager, which will be used to install the extension generator.

Para iniciar la nueva extensión, puede usar el generador de extensiones de Azure Data Studio.To start your new extension, you can use the Azure Data Studio Extension generator. El generador de extensiones Yeoman facilita enormemente la creación de proyectos de extensión sencillos.The Yeoman extension generator makes it very easy to create simple extension projects. Para iniciar el generador, escriba lo siguiente en un símbolo del sistema:To Launch the generator, type the following in a command prompt:

npm install -g yo generator-azuredatastudio

yo azuredatastudio

Referencias de extensibilidadExtensibility References

Para obtener información sobre la extensibilidad de Azure Data Studio, consulte el artículo sobre introducción a la extensibilidad.To learn about Azure Data Studio Extensibility see Extensibility overview. También puede ver ejemplos de uso de la API en ejemplos existentes.You can also see examples of how to use the API in existing samples.

Depuración de una extensiónDebug an extension

Puede depurar la nueva extensión mediante la extensión Debug de Azure Data Studio de Visual Studio Code.You can debug your new extension using Visual Studio Code extension Azure Data Studio Debug.

PasosSteps

  • Abra la extensión con Visual Studio Code.Open your extension with Visual Studio Code
  • Instale la extensión Debug de Azure Data Studio.Install Azure Data Studio Debug extension
  • Presione F5 o hacer clic en el icono de depuración y en Iniciar.Press F5 or click the Debug icon and click Start.
  • Se inicia una nueva instancia de Azure Data Studio en un modo especial (Host de desarrollo de la extensión) y esta nueva instancia tiene ahora en cuenta la extensión.A new instance of Azure Data Studio starts in a special mode (Extension Development Host) and this new instance is now aware of your extension.

Creación de un paquete de extensiónCreate an extension package

Después de escribir la extensión, ha de crear un paquete VSIX para poder instalarlo en Azure Data Studio.After writing your extension, you need to create a VSIX package to be able to install it in Azure Data Studio. Puede usar vsce para crear el paquete VSIX.You can use vsce to create the VSIX package.

npm install -g vsce

vsce package

Publicación de una extensiónPublish an extension

Para publicar la nueva extensión en Azure Data Studio:To publish your new extension to Azure Data Studio:

  1. Agregue la extensión a https://github.com/Microsoft/azuredatastudio/blob/release/extensions/extensionsGallery.json.Add your extension to https://github.com/Microsoft/azuredatastudio/blob/release/extensions/extensionsGallery.json
  2. Actualmente no tenemos soporte para hospedar extensiones de terceros, por lo que en lugar de descargar la extensión, Azure Data Studio tiene la opción de ir a una página de descarga.We currently don't have support to host third party extensions, so instead of downloading the extension, Azure Data Studio has the option to browse to a download page. Para establecer una página de descarga para la extensión, establezca el valor del recurso "Microsoft.AzureDataStudio.DownloadPage".To set a download page for your extension, set the value of asset "Microsoft.AzureDataStudio.DownloadPage".
  3. Cree una solicitud de incorporación de cambios en la rama de versión/extensiones.Create a PR against release/extensions branch.
  4. Envíe una solicitud de revisión al equipo.Send a review request to the team.

La extensión se revisará y se agregará a la galería de extensiones.Your extension will be reviewed and added to the extension gallery.

Publicación de actualizaciones de extensiones El proceso de publicación de actualizaciones es similar al de publicación de una extensión.Publishing Extension Updates The process to publish updates is similar to publishing the extension. Asegúrese de que la versión esté actualizada en package.json.Please make sure the version is updated in package.json