Skip to content

configuring-vscode-environment.md

Latest commit

 

History

History
166 lines (116 loc) · 5.93 KB

configuring-vscode-environment.md

File metadata and controls

166 lines (116 loc) · 5.93 KB

Configurando um ambiente Visual Studio Code no Windows

Este pequeno tutorial pretende mostrar como você configura um ambiente para desenvolver o E5R.Tools.Bit com Visual Studio Code no Windows.

Pré-requisitos

  1. Windows 10
  2. PowerShell
  3. Visual Studio Code
  4. C# para Visual Studio Code
  5. Conexão ativa com a Internet

Etapas de configuração

Considerando que você já adquiriu o código do E5R.Tools.Bit ou por download, ou por outro meio que foi disponibilizado.

Instale o Visual Studio Code

Siga as instruções em https://code.visualstudio.com/docs/setup/windows.

Instale a extensão C#

Siga as instruções em https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp.

Configure os componentes .NET e inicie o VSCode:

Em uma sessão do PowerShell execute o script de bootstrap abaixo para garantir a instalação dos componentes .NET Core e Cake nas versões requeridas.

.\build.ps1 -Target=Bootstrap

Isso demora um pouco dependendo da velocidade de sua conexão com a internet, mas só da primeira vez, nas próximas tende ser bem mais rápido.

Caso você se depare com um erro parecido com esse:

.\build.ps1 : File ...\bit\build.ps1 cannot be loaded because running
scripts is disabled on this system. For more information, see about_Execution_Policies at
https:/go.microsoft.com/fwlink/?LinkID=135170.
At line:1 char:1
+ .\build.ps1
+ ~~~~~~~~~~~
    + CategoryInfo          : SecurityError: (:) [], PSSecurityException
    + FullyQualifiedErrorId : UnauthorizedAccess

É porque sua política de execução de scripts não permite a execução de scripts obtidos da Internet e/ou que não estejam assinados por um certificado digital válido. Então basta você executar o comando abaixo e tentar o primeiro passo novamente:

Set-ExecutionPolicy Bypass CurrentUser

# Executando o primeiro passo novamente
.\build.ps1 -Target=Bootstrap

PS: Nossos scripts ainda não são assinados por um certificado digital. Quem sabe em breve...

Agora, para garantir que você está usando a instalação correta do .NET SDK (a que foi instalada em build/.dotnetsdk no momento em que você executou o comando anterior de bootstrap), nós iremos configurar a nossa variável de ambiente PATH somente na sessão atual do PowerShell.

Em seguida abrimos a pasta do nosso projeto no Visual Studio Code.

$env:Path = (Join-Path (Pwd) "build/.dotnetsdk") + ";${env:Path}"

# Para abrir a pasta atual no Visual Studio Code
code .

PS: Nós usamos a abordagem de sempre instalar uma versão específica do .NET SDK que é necessária para o projeto, com uma versão de .NET Runtime compatível com o Cake também, mesmo se você já tenha uma instalação ativa do .NET SDK na sua máquina. Isso pode parecer um desperdício de tempo e espaço (nós também achamos), mas evita problemas com versões incompatíveis, e fazer com que isso seja resolvido manualmente por cada um. Dessa forma nós garantimos que você sempre trabalhará com a versão adequada para o projeto. (Se quiser ajudar a resolver este problema, nós seremos muito gratos - Veja o Guia de Contribuição para E5R.Tools.Bit)

Crie a tarefa de build

Já com o Visual Studio Code aberto, vamos criar as configurações que nos permitirão depurar o E5R.Tools.Bit adequadamente.

  1. Pressione [CTRL + P] e selecione a opção "Tasks: Configure Default Build Task";

  1. Escolha "Create tasks.json file from template";

  1. Em seguida escolha a opção correspondente ao ".NET Core ...";

  1. Por fim, isso criará o aquivo .vscode/tasks.json, conforme abaixo:

PS: Esse diretório (.vscode) é ignorado nos commits do git para o projeto (veja o arquivo .gitignore), por isso cada desenvolvedor deve configurá-lo novamente. Isso é também muito importante porque o editor/IDE é uma escolha de cada desenvolvedor e não uma restrição do projeto.

Crie a configuração de depuração

  1. Clique no ícone Debug ou pressione CTRL + Shift + D;

  1. Então clique no ícone Configure or Fix 'launch.json' e escolha a opção .NET Core;

  2. Isso criará o aquivo .vscode/launch.json, conforme abaixo:

Sugerimos remover todas as outras configurações, deixando somente a primeira: .NET Core Launch (console), e também sugerimos nomeá-la de E5R.Tools.Bit (Debug).

  1. Ajuste o valor program no JSON conforme abaixo:
"program": "${workspaceFolder}/src/E5R.Tools.Bit/bin/Debug/netcoreapp2.0/bit.dll"
  1. Por fim você deve terminar com um arquivo .vscode/launch.json semelhante a este:
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "E5R.Tools.Bit (Debug)",
      "type": "coreclr",
      "request": "launch",
      "preLaunchTask": "build",
      "program": "${workspaceFolder}/src/E5R.Tools.Bit/bin/Debug/netcoreapp2.0/bit.dll",
      "args": [],
      "cwd": "${workspaceFolder}",
      "console": "internalConsole",
      "stopAtEntry": false,
      "internalConsoleOptions": "openOnSessionStart"
    }
  ]
}

Isso deve ser o suficiente para você marcar seu break point e rodar o E5R.Tools.Bit em modo de depuração.

Agora é só brincar!