vsc-extension-quickstart.md

TOTVS Developer Studio para VSCode

A extensão do TOTVS Developer Studio for VS Code disponibiliza uma suíte de desenvolvimento para o ecossistema Protheus.

Utilizando os protocolos de comunicação LSP (Language Server Protocol) e DAP (Debug Adapter Protocol), ambos amplamente utilizados e extensíveis à outras IDEs de mercado, como Atom, Visual Studio, Eclipse, Eclipse Theia, Vim e Emacs.

Lista de IDEs com suporte ao LSP e ao DAP.

Funcionalidades

• Sintaxe destacada
• Comunicação baseada nos protocolos LSP/DAP
• Console informativo e notificações
• Edição de arquivos fontes (AdvPL, TLPP, 4GL e variantes)
• Compilação de fontes, pastas e da área de trabalho
• Depuração e execução (Local e WebApp)
• Geração e aplicação de pacotes de atualizações (patchs)
• Manutenção do RPO
• Inspeção do RPO
• Geração de cliente de serviço web (Web Service)
• Monitoramento de servidores
• RPO Seguro
• TDS-Cli compilação por linha de comando. Da mesma forma que o Eclipse, essa extensão do VSCode possui uma ferramenta de compilação em linha de comando.
• Navegação em código

Guia rápido

Nunca usei o VS-Code: Recomendamos a leitura de:

• User Interface
• Multi-root Workspaces
• Settings
• Basic Edition
• Marketpalce

Ao iniciar o VS-Code com a extensão TDS-VSCode instalada, abra (ou crie) a pasta principal que contém (ou conterá) seus arquivos fontes e de recursos. Essa pasta é denominada genericamente de projeto.

No primeiro uso da extensão em um projeto, lhe será apresentada as Boas Vindas com configurações mínimas necessárias. Faça-as.

• Acione o icone da TOTVS na barra de atividades
• Resgistre o servidor de trabalho na visão Servidores, acionando a ação +
• Conecte-se ao servidor recém registrado
• Após a conexão, acione na barra de atividades o icone do Explorer
• Abra (ou crie) o arquivo para edição e faça o desenvolvimento necessário
• Compile acionando o atalho ctrl+F9 ou o menu de contexto sobre o arquivo ou recurso
• Corrija eventuais erros de compilação apresentados na visão Problems
• Execute/depure o Smartclient configurado na página de Boas vindas ou direto no arquivo .vscode\launch.json

Para detalhes dos processos, acesse as ligações (links).
A visualização ou não das Boas Vindas pode ser efetuada em File | Preferences | Settings | Extensions | TOTVS | Welcome Page.

Saiba mais em

TOTVS - Extensão de desenvolvimento para VSCode (TEC) - Parte 1
TOTVS - Extensão de desenvolvimento para VSCode (TEC) - Parte 2
TOTVS - TDS-VSCode - Desenvolvimento colaborativo

Acentuação e caracteres especiais

Tivemos reportes de problemas de encode abrindo fontes antes salvos no TDS, isso ocorre porque o encode original do VSCode é UTF8 e o do TDS é outro. Para garantir a compilação é necessário compatibilizar o encode da seguinte maneira:

• No estado original o Fonte será mostrado desta maneira:
  
• Antes de editar/salvar qualquer fonte no VS entre nas configurações do VS Ctrl + ,.
• No campo de busca digite encode e selecione Windows1252 ou Windows1253 se utilizar alfabero cirílico.
  
• Abra o fonte com o novo encode (reforçando que NÃO DEVE tê-lo salvo antes em UTF8)
  
• Compile e/ou recompile o fonte e execute-o.
  

Por padrão, o TDS-VSCode já vem configurado para usar o encodin WindowsCP1252.

Desenvolvimento Colaborativo

• Se deseja contribuir com o desenvolvimento do plugin, acesse Git Hub TDS-VSCODE, faça seu commit que iremos analisar!

Extensões recomendadas

• Numbered Bookmarks

  Permite uso de bookmarks no estilo Delphi numerados de 1 a 9.

  

Suporte

Capturador de Logs

Caso tenha problemas com a ferramenta e deseja suporte da equipe de desenvolvimento da extensão, inicie uma ferramenta de coleta de logs para auxiliar no suporte. Essa ferramenta colhe informações como versões de ferramentas e extensões, sistema operacional, configuração de servidores e etc.

• Para ativa-la, selecione pelo atalho CTRL + SHIFT + P, digite TOTVS: On Logger Capture. Nesse momento o capturador de log será iniciado.

• Reproduza o problema e selecione a opção CTRL + SHIFT + P digite TOTVS: Off Logger Capture ou na Barra inferior clique sobre o texto Capturando logs.... O capturador será encerrado e um arquivo chamado tdsSupport.zip será gerado. Anexe esse arquivo ao chamado.

Resolução de problemas

Alguns problemas conhecidos e como resolvê-los.

TROUBLESHOOTING

Se não conseguir resolvê-los com isso, abra um Issue com o maior número de informações possíveis e envie os logs gerados pelas instruções na página de "Troubleshooting".

Acesse Nova Issue e selecione "Bug report".

Melhorias

Se você sentiu a falta de alguma funcionalidade deixe sua idéia registrada.

Acesse Nova Issue e selecione "Feature request".

Ou se preferir colabore conosco e faça você mesmo. Veja como colaborar a seguir.

Desenvolvimento Colaborativo

Para contribuir com o desenvolvimento da extensão, acesse Git Hub TDS-VSCODE, faça um fork do projeto, crie uma "Pull Request" que iremos analisar!

TOTVS - TDS-VSCode - Desenvolvimento colaborativo

Colaboradores

Alan Cândido 💻 📖	lwtnb-wrk 💻 📖	DanielYampolschi 💻 📖	Matheus Sales 💻 📖	Mansano 💻 📖	Acacio Egas 💻
Daniel Otto Bolognani 💻	Leo Watanabe 💻 📖	Rogério Ribeiro da Cruz 💻	Robson William ⚠️	FELIPE CAIADO ALMEIDA 🐛	isaquerochak 🐛
Rodrigo Gonçalves 🐛	Rogério A. Morais 💻	alexmmartins 📖	Guilherme Bigois 📖

Extensões recomendadas

• Numbered Bookmarks

  Permite uso de bookmarks no estilo Delphi numerados de 1 a 9.

  

Extensões com incompatibilida

As extensões abaixo não devem ser utilizadas junto com o TDS for VS-Code porque podem causar mal funcionamento.

• (4gl-outine-dxc)[https://www.vsixhub.com/vsix/14295/]

• (advpl-vscode)[https://github.com/totvs/advpl-vscode]

Caso você perceba que alguma extensão de terceiros esta interferindo no TDS for VS-Code favor abrir um (chamado)[(https://github.com/totvs/tds-vscode/issues].