Criar uma extensão do Assistente do Azure Data Studio

Este tutorial demonstra como criar uma nova extensão do Assistente do Azure Data Studio. A extensão contribui com um assistente para interagir com os usuários no Azure Data Studio.

Neste artigo, vai aprender a:

Pré-requisitos

O Azure Data Studio é criado na mesma estrutura do Visual Studio Code, portanto, as extensões para o Azure Data Studio são criadas usando o Visual Studio Code. Para começar, você precisa dos seguintes componentes:

• Node.js instalado e disponível no seu $PATH. Node.js inclui o npm, o Node.js Package Manager, que é usado para instalar o gerador de extensão.
• Visual Studio Code para depurar a extensão.
• A extensão de depuração do Azure Data Studio (opcional). Isso permite que você teste sua extensão sem precisar empacotá-la e instalá-la no Azure Data Studio.
• Certifique-se de azuredatastudio que está no seu caminho. Para Windows, certifique-se de escolher a Add to Path opção em setup.exe. Para Mac ou Linux, execute o comando Instalar 'azuredatastudio' no PATH a partir da Paleta de Comandos no Azure Data Studio.

Instale o gerador de extensões

Para simplificar o processo de criação de extensões, construímos um gerador de extensões usando o Yeoman. Para instalá-lo, execute o seguinte no prompt de comando:

npm install -g yo generator-azuredatastudio

Crie sua extensão de assistente

Introdução aos assistentes

Os assistentes são um tipo de interface de usuário que apresenta páginas passo a passo para os usuários preencherem, a fim de realizar uma tarefa. Exemplos comuns incluem assistentes de configuração de software e assistentes de solução de problemas. Por exemplo:

Como os assistentes geralmente são úteis ao trabalhar com dados e estender a funcionalidade do Azure Data Studio, o Azure Data Studio oferece APIs para criar seus próprios assistentes personalizados. Explicaremos como gerar um modelo de Assistente e modificá-lo para criar seu próprio assistente personalizado.

Execute o gerador de extensões

Para criar uma extensão:

1. Inicie o gerador de extensões com o seguinte comando:

   yo azuredatastudio

2. Escolha Novo Assistente ou Caixa de Diálogo na lista de tipos de extensão. Em seguida, selecione Assistente, seguido pelo Modelo de Introdução

3. Siga as etapas para preencher o nome da extensão (para este tutorial, use Minha extensão de teste) e adicione uma descrição.

   

Concluir as etapas anteriores cria uma nova pasta. Abra a pasta no Visual Studio Code e você está pronto para criar sua própria extensão de assistente!

Execute a extensão

Vamos ver o que o modelo de assistente nos dá executando a extensão. Antes de executar, verifique se a extensão de depuração do Azure Data Studio está instalada no Visual Studio Code.

Selecione F5 no VS Code para iniciar o Azure Data Studio no modo de depuração com a extensão em execução. Em seguida, no Azure Data Studio, execute o comando Iniciar Assistente a partir da Paleta de Comandos (Ctr+Shift+P) na nova janela. Isso iniciará o assistente padrão com o qual essa extensão contribui:

Em seguida, veremos como modificar esse assistente padrão.

Desenvolver o assistente

Os arquivos mais importantes para começar com o desenvolvimento de extensão são package.json, src/main.tse vsc-extension-quickstart.md:

• package.json: Este é o arquivo de manifesto, onde o comando Launch Wizard está registrado. É também aqui que main.ts é declarado o principal ponto de entrada do programa.
• main.ts: Contém o código para adicionar elementos da interface do usuário ao Assistente, como páginas, texto e botões
• vsc-extension-quickstart.md: Contém documentação técnica que pode ser uma referência útil durante o desenvolvimento

Vamos fazer uma alteração no assistente: adicionaremos uma 4ª página em branco. Modifique src/main.ts como mostrado abaixo, e você verá uma página adicional aparecer quando iniciar o assistente.

Depois de estar familiarizado com o modelo, aqui estão algumas ideias adicionais para experimentar:

• Adicionar um botão com uma largura de 300 à sua nova página
• Adicione um componente flex para colocar o botão
• Adicione uma ação ao seu botão. Por exemplo, quando o botão é clicado, inicie uma caixa de diálogo de abertura de arquivo ou abra um editor de consultas.

Empacote sua extensão

Para compartilhar com outras pessoas, você precisa empacotar a extensão em um único arquivo. Isso pode ser publicado no mercado de extensão do Azure Data Studio ou compartilhado entre sua equipe ou comunidade. Para fazer isso, você precisa instalar outro pacote npm a partir da linha de comando:

npm install -g vsce

Edite o README.md ao seu gosto, navegue até o diretório base da extensão e execute vsce package. Opcionalmente, você pode vincular um repositório à sua extensão ou continuar sem um. Para adicionar uma, adicione uma linha semelhante ao seu package.json ficheiro.

"repository": {
    "type": "git",
    "url": "https://github.com/anjalia/my-test-extension.git"
}

Depois que essas linhas foram adicionadas, um arquivo my-test-extension-0.0.1.vsix foi criado e pronto para instalação no Azure Data Studio.

Publique sua extensão no mercado

O mercado de extensão do Azure Data Studio ainda não está totalmente implementado, mas o processo atual é hospedar a extensão VSIX em algum lugar (por exemplo, uma página de versão do GitHub) e, em seguida, enviar uma RP atualizando esse arquivo JSON com suas informações de extensão.

Próximos passos

Neste tutorial, ficou a saber como:

Esperamos que, depois de ler isso, você se inspire para criar sua própria extensão para o Azure Data Studio. Temos suporte para Dashboard Insights (gráficos bonitos que são executados em seu SQL Server), várias APIs específicas do SQL e um enorme conjunto existente de pontos de extensão herdados do Visual Studio Code.

Se você tem uma ideia, mas não sabe como começar, abra uma edição ou tweete na equipe: azuredatastudio.

Você sempre pode consultar o guia de extensão de código do Visual Studio porque ele abrange todas as APIs e padrões existentes.

Para saber como trabalhar com T-SQL no Azure Data Studio, conclua o tutorial do Editor T-SQL: