Como instalar e configurar o VS Code com AdvPL

Para quem quer outra opção sem ser o TDS para substituir o Dev Antigo, hoje vou mostrar como instalar e configurar o Visual Studio Code junto com o AdvPL.


Essa integração foi criada para que programadores utilizassem uma plataforma mais leve que o TDS (que veio do Eclipse). O VS Code está sendo cada vez mais difundido e utilizado em São Paulo e em outras regiões.

ATENÇÃO: no dia 23/12/2019, criei um artigo mostrando como instalar o plugin oficial da TOTVS, então você pode desconsiderar o passo 3 em diante, e levar em consideração apenas o desse artigo – Como configurar o plugin oficial da TOTVS no VSCode

A documentação da integração do AdvPL com o VS Code pode ser visualizada clicando aqui.

Instalando o VS Code

1. Fazer o download através do link – code.visualstudio.com/download

Download do Visual Studio Code

2. Prossiga com a instalação e marque as opções que desejar

Opções da Instalação

Usando a extensão oficial da TOTVS

3. Continue a configuração acessando o artigo – Como configurar o plugin oficial da TOTVS no VSCode

Tutorial antigo (usando o do killerall - Rodrigo Antonio Godinho)

Adicionando Extensões

3. Clique na área de Extensões

Procurando extensões

4. Procure por “Portuguese (Brazil) Language Pack” e clique em Install

Extensão para deixar em português o VS Code

5. Faça o mesmo procedimento, agora procurando por “AdvPL” e clique em Install

Extensão do AdvPL

Criando e configurando um projeto em AdvPL

6. Clique em Arquivo > Salvar Espaço de Trabalho Como, e escolha um diretório para salvar sua Workspace

Salvar Workspace

7. Crie um código fonte qualquer, que iremos testar mais para frente

Criando um fonte de exemplo

//Bibliotecas
#Include "Protheus.ch"

/*/{Protheus.doc} zTeste2
Função de Teste para o VS Code
@type  Function
@author Atilio
@since 20/01/2019
@version 1.0
@example
u_zTeste()
/*/
User Function zTeste2()
Local aArea := GetArea()

//Mostrando uma mensagem
Alert("Mensagem de Teste - VS Code")

RestArea(aArea)
Return

8. Abra o arquivo de configuração da workspace, cole o conteúdo abaixo, e altere as definições de diretórios, serviço e porta. A senha por enquanto pode deixar como 123. Abaixo eu configurei 2 ambientes de teste.

Configurando os ambientes

{
	"folders": [
		{
			"path": "."
		}
	],
	"settings": {
		
		"advpl.environments":[{
				"smartClientPath": "E:\\TOTVS\\Smartclient\\",
				"environment": "TESTE1",
				"includeList": "E:\\TOTVS\\TOTVS Developer Studio\\Include\\",
				"server": "localhost",
				"port": "1235",
				"user": "Admin",
				"passwordCipher": "123"
			},
			{
				"smartClientPath": "E:\\TOTVS\\Smartclient\\",
				"environment": "TESTE2",
				"includeList": "E:\\TOTVS\\TOTVS Developer Studio\\Include\\",
				"server": "localhost",
				"port": "1235",
				"user": "Admin",
				"passwordCipher": "123"
			}]
	}
}

9. No canto inferior direito, clique em Ambiente, e escolha um Environment que você configurou

Selecionando ambiente

10. Agora pressione o atalho Ctrl + P, digite “>cipher” (sem aspas) e pressione enter, depois digite a senha de login do usuário que você configurou no passo 8

Utilizando o cipher

11. Copie a senha gerada e cole no lugar daquele 123 que deixamos no passo 8

Pegando a senha gerada

12. Compile o fonte com o atalho Ctrl + F9, e execute o Protheus com o atalho Ctrl + F11

13. Teste a rotina em algum lugar do sistema para ver se deu certo

Testando função no Protheus

14. Para ver algumas opções disponíveis do Advpl, pressione Ctrl + P, e digite “>advpl” (sem aspas)

Opções do AdvPL

Configurando SVN (Opcional)

15. Na parte de Extensões, procure SVN e instale

Extensão SVN

16. Pressione Ctrl + P e digite “>svn” (sem aspas), e escolha a opção Checkout

Opção Checkout

17. Insira a URL do repositório, e depois escolha uma pasta que ficará os arquivos no computador

URL do repositório

18. Insira um nome para pasta SVN

Nome da Pasta

19. Será perguntado se deseja abrir o repositório ou adicionar na workspace, nesse exemplo vamos utilizar Add To Workspace

Opção de adicionar a Workspace

20. Agora será mostrado os arquivos normalmente, e para realizar alterações (como Commit e Update), clique na área de Controle de Código Fonte, veja o projeto e pode fazer as alterações

Opção de Commit


Observação: Caso precise gerar um arquivo de configuração da workspace, faça:

1. Arquivo > Fechar Espaço de Trabalho

2. Arquivo > Salvar Espaço de Trabalho como…

3. Adicione / Crie um arquivo prw e abra ele

4. Clique em Depurar (Ctrl + Shift + D)

5. Onde tem “Sem Configurações”, clique no combo e depois clique em “Adicionar config (Espaço de Trabalho)”


Bom pessoal, por hoje é só.

Abraços e até a próxima.

Dan Atilio (Daniel Atilio)
Especialista em Engenharia de Software pela FIB. Entusiasta de soluções Open Source. E blogueiro nas horas vagas.

21 Responses

  1. Rafael Arcanjo disse:

    “Abra o arquivo de configuração da workspace”
    Onde ? 🙁

  2. Rafael Arcanjo disse:

    Ah, tá no FINAL do artigo…

  3. Jefferson disse:

    É possível aplicar patch’s pelo VS Code também?

  4. Boa tarde @Dan_Atilio.

    Recomenda também a instalação da extensão ‘AdvPL Switch Project’.

    Criei a mesma com a intenção de suprir uma dificuldade que os usuários do VsCode enfrentam que é o gerenciamento de projetos/branches, ambientes x projeto, … Coisa que o TDS auxiliava mas que o VsCode não tem implementado por padrão.

    Agradeço se puder divulgar, ela veio para ajudar a comunidade Advpl.

    • Dan_Atilio disse:

      Opa, obrigado Gabriel pelo comentário.
      Já deixei o comentário aprovado no artigo, depois vou ver se consigo fazer um artigo sobre essa extensão.
      Grande abraço jovem.

  5. Pablo Polito disse:

    Boa tarde @Dan_Atilio, tudo certo ?

    Sabe me dizer porque não consigo adicionar um SVN pelo comando ” >svn.checkout ” ???

    Ele da essa mensagem de erro
    ” command ‘svn.checkout’ not found “

  6. Juliano disse:

    Estou tentando aplicar o patch pelo VSCode da ferramenta para criar um compatibilizador (https://www.ernaniforastieri.com/products/expordic1) mas não estou conseguindo. aguem pode me ajudar?

  7. Neto disse:

    Dan_Atilio boa tarde!
    Eu fiz a instalação do VsCode no meu Mac, mas ele não aceita o smartclient do mac… É isso mesmo? Só funciona com o smartclient do Windows?

    • Dan_Atilio disse:

      Bom dia Neto, tudo bem?
      Ele funciona em qualquer sistema operacional, a diferença é que, quando você for configurar em distros Linux ou Mac, você tem que ir pelo explorador de arquivos e copiar o caminho do executável na mão.
      Após copiar, tem que colar no campo referente ao smartclient.
      Abraços.

  8. WALTER ARAUJO FRANCO disse:

    Olá Dan_Atilio,
    Para remover um fonte qq do meu RPO eu vi que tem a opção pelo Ctrl+P porém, ele retorna este erro:

    Starting the exclusion of the sources…lj7087

    Erro to try delete resource, see de appserver console.
    Starting the exclusion of the sources…LJ7087

    Erro to try delete resource, see de appserver console.

    Eu já olhei no console mas não há nada relacionado ao processo que solicitei.
    Como faço para remover um fonte que não preciso mais do RPO?
    Obrigado e parabéns pelo post, ajudou muito!!!
    Abs

    Walter Franco

    • Dan_Atilio disse:

      Bom dia Walter, tudo bem?
      Para remover eu não costumo utilizar a Paleta de Comandos.
      Na visão da workspace, eu encontro o código fonte, clico com o botão direito nele, e vou em “Delete File/Resource from RPO”.
      Grande abraço.

      • WALTER ARAUJO FRANCO disse:

        Olá,
        Devo estar usando uma workspace diferente então, pois a minha só faz a exclusão do arquivo na workspace, não removendo do RPO, por isso estava tentando pelo outro comando.
        Vou continuar estudando a causa aqui…
        Vlw pela dica…
        Abs

        Walter Franco

  9. Emerson Campos disse:

    Bom dia,
    Seu post foi de grande utilidade, então antes de mais nada muito obrigado, agora em relação a instalação do SVN, ao instalar a extensão aparece uma msnsagem abaixo para inserir o executável, você precisou ter instalado o SVN local? Pois aqui utilizamos o SVN em um Servidor a parte e no Eclipse não necessitava disso.

    Poderia detalhar como fez essa configuração antes de chegar no SVN:Checkout do seu passo a passo acima…

    Grato

    • Dan_Atilio disse:

      Bom dia Emerson, tudo bem?
      Esse plugin do SVN funcionava bem, a parte de ter instalado local, é apenas o visualsvn server, mesmo que não tenha configurado, bastava ter ele instalado.
      Mas depois de algumas atualizações, acabou que alguns recursos ficaram estranhos, então comecei a usar outro plugin, o do tortoise (que também precisa ter instalado o exe na máquina).
      Abraços.

  10. Marcel Medeiros Guimarães disse:

    Não estou conseguindo compilar, está pedindo uma configuração chamada Compile Key. Pode me ajudar?

Deixe uma resposta