Histórico da Página
INTRODUÇÃO
O editor de código-fonte Visual Studio Code, ou simplesmente VSCode, é ferramenta multiplataforma e amplamente utilizada para desenvolvimento com várias linguagens de programação através da instalação de extensões (plugins).
A TOTVS desenvolveu a extensão TOTVS Developer Studio Code para desenvolvimento nas linguagens ADVPL, 4GL e TLPP, sendo que a linguagem 4GL, utilizada para desenvolvimento do produto LOGIX, está disponível para uso desde o início do 2o semestre de 2020.
A seguir serão apresentados tópicos resumidos envolvendo algumas dicas e procedimentos de instalação e configuração do VSCode e extenão TDS for VSCode, sendo que em alguns pontos serão apenas apontados alguns links de páginas oficiais existentes no site GitHub onde encontram-se as documentações oficiais da ferramenta.
Expandir | |||||
---|---|---|---|---|---|
| |||||
Se você ainda não tem o editor VSCode instalado, acesse https://code.visualstudio.com/, faça o download para a plataforma desejada e instale conforme passo-a-passo do site oficial.
|
Expandir | |||||
---|---|---|---|---|---|
| |||||
A partir do editor VSCode, acompanhando a ilustração de itens na imagem abaixo, acesse na barra de ferramentas disponível na lateral esquerda na posição vertical, o atalho de extensões do VSCode, destacado no item (1) abaixo, informe "TDS" na caixa superior de filtro, item (2), selecione a extensão TOTVS Developer Studio for VSCode (AdvPL, TLPP e 4GL) conforme mostra o item(3) e cliquei em INSTALL item (4).
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
No Logix o formato de codificação padrão dos códigos fonte é ISO8859-1 ou CP1252 e para que isso seja reconhecido automaticamente no VSCode é preciso configurar a lista de extensões dos arquivos fontes previstos para cada linguagem, sendo que no Logix fazemos uso atualmente de 3 linguagens de desenvolvimento, sendo: 4GL, ADVPL e TLPP, sendo esta última prevista a partir do build Harpia.
No VSCode acesse no menu Com o arquivo settings.json aberto para edição inclua as configurações abaixo, verificando sempre se as respectivas chaves já estão informadas, para que não sejam registradas de forma duplicada.
Salve o arquivo e a partir de agora seu editor VSCode já irá abrir cada fonte desenvolvido no LOGIX respeitando o formato de codificação (ENCODE) correto para não gerar problemas durante a execução do produto após compilação dos fontes, onde podem ser exibidas os textos em telas e mensagens contendo caracteres estranhos, por terem sido salvos com ENCODE incorreto. Caso surja mais alguma extensão de arquivo que não esteja na lista acima, pode ser adicionada, desde que respeitando o formato e delimitadores das chaves e valores no arquivo settings.json. |
Expandir | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Para criar um espaço de trabalho (Workspace) para desenvolvimento no LOGIX, a exemplo do TDS (Totvs Developer Studio) podíamos indicar uma pasta para armazenar todas as configurações desejadas, onde tínhamos um projeto com a lista de fontes em formato de árvore (TreeView) e também era possível configurar a lista de pastas de includes para o projeto (utilizados para compilação de fontes ADVPL). Para o VSCode isso não muda, pois também é possível abrir tanto um único arquivo como uma pasta completa e no caso de abertura de uma pasta o VSCode entende que estamos definindo um novo espaço de trabalho (Workspace), onde então ele cria automaticamente uma subpasta chamada .vscode\ onde irá armazenar todos os arquivos das configurações utilizadas. Toda vez que uma pasta nova é aberta a partir do VSCode e consequentemente uma nova Workspace é criada, por padrão será apresentada uma tela de Boas Vindas conforme imagem abaixo:
Informar as pastas de localização dos arquivos de INCLUDES. Estas pastas são utilizadas para compilação de fontes desenvolvidos na linguagem ADVPL, sendo as pastas separadas por ponto e vírgula. No caso de fontes 4GL não é necessário informar este campo. A janela de Boas Vindas não aparece?Para ativar ou desativar a exibição da janela de Boas Vindas é preciso mudar a configuração Totvs Language Server: Welcome Page ( |
Expandir | |||||
---|---|---|---|---|---|
| |||||
Para ajustar configurações de um atalho existente d do Smartclient é possível acionar a partir da lista de comandos no VsCode o comando TOTVS:Configure Launchers. Pressione o atalho CTRL+SHIFT+P e informe o filtro do comando como "TOTVS" conforme imagem abaixo e selecione TOTVS:Configure Launchers
É possível também registrar alterações dos atalhos do Smartclient diretamente no arquivo de configuração de forma manual no arquivo /.vscode/launch.json existente na pasta de workspace aberta no VsCode. Para isso a partir do editor VSCode, acompanhando a ilustração de itens na imagem abaixo, acesse na barra de ferramentas disponível na lateral esquerda na posição vertical, o atalho de excução "Run and Debug", destacado no item (1) abaixo, em seguida selecione o atalho do smartclient desejado item (2) e em seguida clique sobre o botão de configurações ao lado item (3) para que seja possível abrir para edição o arquivo launch.json correto, já que para cada Workspace criada no TDS-VSCode existirá um arquivo launch.json diferente com a configuração de atalhos de Smartclient.
|
Expandir | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Para criar uma conexão com um novo AppServer para desenvolvimento no LOGIX, a partir do editor VSCode, acompanhando a ilustração de itens na imagem abaixo, acesse na barra de ferramentas disponível na lateral esquerda na posição vertical, o atalho TOTVS AppServer , destacado no item (1) abaixo, depois clique no na opção na caixa superior de filtro, item(2).
|
Expandir | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
Após conexão do AppServer já ter sido criada, deve-se registrar os ambientes de execução ou Environment, que já estão configurados no arquivo INI do AppServer. Diferentemente de como os ambientes do AppServer eram acessados no TDS, onde ao conectar um AppServer já tínhamos disponíveis todos os ambientes para uso já registrados no AppServer, via TDS for VSCode deve-se registrar os ambientes um a um, baseados nos ambientes já registrados no arquivo INI do AppServer. Não sabe o que é um Environment ou Ambiente no AppServer? Um ambiente ou Environment é uma seção do arquivo INI do AppServer onde configuramos o acesso para execução de programas, indicando caminho do repositório de objetos (RPO), banco de dados a ser conectado, pasta raiz do AppServer (ROOTPATH), pasta inicial de trabalhos (STARTPATH), arquivo de SCHEMA de banco de dados utilizado na compilação de fontes 4GL (arquivos com extensão .sch). Veja um exemplo abaixo de um ambiente de conexão no AppServer utilizado para execução do produto Logix:
|
Expandir | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Para compilar fontes ADVPL e 4GL, o processo é bem semelhante a antiga ferramenta de desenvolvimento TDS, no entanto no VSCode é OBRIGATÓRIA a utilização de uma CHAVE DE COMPILAÇÃO. Para saber de mais informações a respeito da chave de compilação, acesse o item Solicitando e aplicando Chave de compilação. Seguem algumas opções de compilação de fontes:
|
Expandir | |||
---|---|---|---|
| |||
Para executar um programa já compilado no RPO do ambiente/AppServer conectado é simples. Basta clicar na opção Run and Debug (Ctrl + Shift + D), identificado pela imagem na barra de ferramentas lateral, conforme mostra imagem do PASSO 1, selecionar o launcher desejado e clicar no botão play.
|
Expandir | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
Para executar um programa em modo DEBUG, basta seguir os seguintes passos:
|
Expandir | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
As etapas a seguir apresentam uma forma de geração e aplicação de PATCH.
|
Expandir | ||
---|---|---|
| ||
As atualizações do VSCode podem ser baixadas manualmente do site GITHUB no link (https://github.com/totvs/tds-vscode/releases/), preferencialmente procurando pela revisão descrita como Na página de releases do TDS for VSCode, o arquivo com extensão .vsix é utilizado para ser instalação manual da extensão a partir do VSCode e é exibido na página de releases conforme exemplo na imagem abaixo: Baixe o arquivo .VSIX e instale-o a partir do VSCode utilizando o passo a passo a seguir:
Para confirmar a versão da extensão instalada, basta clicar sobre a extensão TDS for VSCode que já estará sendo exibida na lista de extensões conforme imagem abaixo: e na lateral direita conferir a versão da extensão conforme item(1) abaixo: PRONTO! Sua extensão TDS for VSCode foi instalada/atualizada com sucesso. |
INFORMAÇÕES COMPLEMENTARES
Para saber mais detalhes de como instalar, configurar e obter dicas de uso do TDS for VSCode, acesse o link https://marketplace.visualstudio.com/items?itemName=totvs.tds-vscode
Este link além de apresentar uma idéia geral a respeito da extensão TDS for VSCode, demonstra o passo-a-passo para instalação e configuração de algumas funcionalidades e também dispõe de link de acesso para alguns vídeos que são recomendados para melhorar a familiarização com esta solução para desenvolvimento do produto Logix.
Para reportar problemas ou até sugerir melhorias relacionadas a extensão TDS for VSCode, acesse a aba ISSUES https://github.com/totvs/tds-vscode/issues e reporte a necessidade, seguindo as orientações descritas de como realizar abertura das novas ISSUES.