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/Logix.
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.
A extensão TDS-VSCode somente é suportada por S.O. de 64 bits.
Funcionalidades
SOBRE O USO DE CHAVES E TOKENS DE COMPILAÇÃO
As chaves de compilação ou tokens de compilação empregados na construção do Protheus/Logix e suas funcionalidades, são de uso restrito dos desenvolvedores de cada módulo.
Em caso de mau uso destas chaves ou tokens, por qualquer outra parte, que não a referida acima, a mesma irá se responsabilizar, direta ou regressivamente, única e exclusivamente, por todos os prejuízos, perdas, danos, indenizações, multas, condenações judiciais, arbitrais e administrativas e quaisquer outras despesas relacionadas ao mau uso, causados tanto à TOTVS quanto a terceiros, eximindo a TOTVS de toda e qualquer responsabilidade.
Interoperabilidade entre sistemas operacionais
Para melhor interoperabilidade do ecosistema Protheus (áreas de trabalho, smartClient, appServer e demais componentes) entre os sistemas operacionais suportados pelo TDS-VSCode e seus componentes, recomenda-se veementemente que pastas e arquivos não contenham caracteres especiais e/ou acentuados e sempre em mínusculas.
Leia Convenção para nomenclatura de File System em ambiente Linux.
Guia rápido
O VS Code pode apresentar problemas em suas funcionalidades em sistemas operacionais da linha Windows Server.
Veja os requisitos para uso do VS Code em Requirements.
Nunca usei o VS Code: Recomendamos a leitura de:
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 ícone da
TOTVS na barra de atividades
- Registre o servidor de trabalho na visão (Servidores)[docs/servers.md], acionando a ação
+
- (Conecte-se)[docs/servers.md] ao servidor recém registrado
- Após a conexão, acione na barra de atividades o ícone do
Explorer
- Abra (ou crie) o arquivo para edição e faça o desenvolvimento necessário
- (Compile)[docs/compilation.md] 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)[docs/debugging.md] 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 (TEC)
Acentuação e caracteres especiais nos códigos fontes
Tivemos notificações de problemas de encode abrindo fontes antes salvos no TDS, isso ocorre porque o encode original do VSCode é UTF8 e o do TDS-VSCode é 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-Code entre nas configurações (
Ctrl + ,).
- No campo de busca digite
_encode_ e selecione Windows1252 ou Windows1251, se utilizar alfabeto 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 encode Windows1252 (cp1252).
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
As extensões abaixo não devem ser utilizadas junto com o TDS-VS-Code porque podem causar mal funcionamento.
Caso você perceba que alguma outra extensão de terceiros está interferindo no TDS for VS-Code, favor abrir um chamado informando detalhes da extensão e o problema causado.
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 ativá-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.
| Ocorrência |
Solução |
| Aplicação de pacotes de atualização (patches) |
|
Servidores Lobo Guara, versão igual ou anterior a 19.3.0.5, podem apresentar mensagem de erro no processo de validação e mesmo assim aplicá-lo. |
Atualizar o servidor para a versão mais recente. |
Se não conseguir resolvê-los, abra um chamado com o maior número de informações possíveis e inclua os logs gerados conforme instruído em TROUBLESHOOTING.
Melhorias
Se você sentiu a falta de alguma funcionalidade deixe sua idéia registrada.
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 um chamado "Pull Request" que iremos analisar!
TOTVS - TDS-VSCode - Desenvolvimento colaborativo
Mantenedor
Colaboradores
