Estender a funcionalidade criando extensões do Azure Data Studio
As extensões no Azure Data Studio fornecem uma maneira fácil de adicionar mais funcionalidade à instalação base do Azure Data Studio.
As extensões são fornecidas pela equipe do Azure Data Studio (Microsoft), bem como pela comunidade de terceiros (você!).
Autor de uma extensão
Se estiver interessado em estender o Azure Data Studio, pode criar a sua 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 Node.js instalado e disponível em seu $PATH. Node.js inclui o npm, o Node.js Package Manager, que é usado para instalar o gerador de extensão.
Para criar sua nova extensão, você pode usar o gerador de extensões do Azure Data Studio. O gerador de extensão Yeoman é um ponto de partida benéfico para projetos de extensão. Para iniciar o gerador, digite o seguinte comando em um prompt de comando:
npm install -g yo generator-azuredatastudio
yo azuredatastudio
Para obter um guia detalhado sobre como começar a usar seu modelo de extensão, consulte a extensão keymap, que o orienta na criação de uma extensão.
Referências de extensibilidade
Para saber mais sobre a extensibilidade do Azure Data Studio, consulte Visão geral da extensibilidade. Você também pode ver exemplos de como usar a API em exemplos existentes.
Depurar uma extensão
Você pode depurar sua nova extensão usando a extensão de código do Visual Studio Azure Data Studio Debug.
Para depurar sua extensão:
- Abra sua extensão com o Visual Studio Code.
- Instale a extensão de depuração do Azure Data Studio.
- Selecione F5 ou selecione o ícone Depurar e, em seguida, selecione Iniciar.
- Uma nova instância do Azure Data Studio é iniciada em um modo especial (Host de Desenvolvimento de Extensão). Esta nova instância agora está ciente de sua extensão.
Criar um pacote de extensão
Depois de escrever sua extensão, você precisa criar um pacote VSIX que seja instalado no Azure Data Studio. Você pode usar vscode-vsce (Visual Studio Code Extensions) 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 sua extensão local e privadamente compartilhando o arquivo .vsix e usando o comando Extensões: Instalar do Arquivo VSIX da paleta de comandos para instalar a extensão no Azure Data Studio.
Publicar uma extensão
Para publicar sua nova extensão no Azure Data Studio:
- Adicione sua extensão à galeria de extensões.
- No momento, não temos 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.
- Crie uma ramificação PR contra release/extensions.
- Envie um pedido de revisão para a equipa.
Sua extensão será revisada e adicionada à galeria de extensões.
Publicar atualizações de extensão
O processo para publicar atualizações é semelhante à publicação da extensão. Certifique-se de que a versão está atualizada no package.json.
Próximos passos
Consulte um dos seguintes tutoriais de criação de extensões para obter instruções passo a passo sobre como começar: