Estender a funcionalidade criando extensões do Azure Data Studio

  • Artigo

As extensões no Azure Data Studio fornecem uma forma fácil de adicionar mais funcionalidade à instalação básica do Azure Data Studio.

As extensões são fornecidas pela equipe do Azure Data Studio (Microsoft), bem como pela comunidade de terceiros (você!).

Criar uma extensão

Se tiver interesse em estender o Azure Data Studio, você poderá criar a própria extensão e publicá-la na galeria de extensões.

Escrever uma extensão

Pré-requisitos

Para desenvolver uma extensão, você precisa ter o Node.js instalado e disponível em seu $PATH. O Node.js inclui o npm, o Gerenciador de Pacotes do Node.js, que é usado para instalar o gerador de extensão.

Para criar sua extensão, você pode usar o gerador de extensão do Azure Data Studio. O gerador de extensão Yeoman é um bom ponto de partida para projetos de extensão. Para iniciar o gerador, insira o seguinte comando em um prompt de comando:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Para obter um guia detalhado de como começar a usar seu modelo de extensão, confira extensão de mapa de teclas, que orienta você durante a criação de uma extensão.

Referências de extensibilidade

Para saber mais sobre a extensibilidade do Azure Data Studio, confira Visão geral de extensibilidade. Você também pode ver exemplos de como usar a API em amostras existentes.

Depurar uma extensão

Você pode depurar sua nova extensão usando a extensão do Visual Studio Code Depuração do Azure Data Studio.

Para depurar sua extensão:

  1. Abra a extensão com o Visual Studio Code.
  2. Instale a extensão de Depuração do Azure Data Studio.
  3. Selecione F5 ou o ícone Depurar e, em seguida, Iniciar.
  4. Uma nova instância do Azure Data Studio é iniciada em um modo especial (Host de Desenvolvimento de Extensão). Essa nova instância agora está ciente da sua extensão.

Criar um pacote de extensão

Depois de escrever a extensão, você precisa criar um pacote VSIX que a instala no Azure Data Studio. Você pode usar vscode-vsce (Extensões do Visual Studio Code) para criar o pacote VSIX.

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

Com um pacote VSIX, você pode compartilhar a extensão localmente e de maneira privada compartilhando o arquivo .vsix e usando o comando Extensões: fazer a instalação com base no arquivo VSIX na paleta de comandos para instalar a extensão no Azure Data Studio.

Publicar uma extensão

Para publicar sua nova extensão para o Azure Data Studio:

  1. Adicione sua extensão à galeria de extensões.
  2. No momento, não há suporte para hospedar extensões de terceiros. Em vez de baixar a extensão, o Azure Data Studio tem a opção de navegar até uma página de download. Para definir uma página de download para sua extensão, defina o valor do ativo Microsoft.AzureDataStudio.DownloadPage.
  3. Crie uma PR em relação ao branch de versão/extensões.
  4. Envie uma solicitação de análise para a equipe.

Sua extensão será examinada e adicionada à galeria de extensões.

Publicar atualizações de extensão

O processo de publicar atualizações é semelhante ao de publicar a extensão. Verifique se a versão está atualizada em package.json.

Próximas etapas

Confira um dos seguintes tutoriais de criação de extensões para obter instruções passo a passo sobre como começar a criá-los: