DEV Community: Lucas Luan de Melo

How to Set Up Solargraph in VS Code with WSL2

Lucas Luan de Melo — Fri, 21 Jun 2024 12:49:32 +0000

Introduction

Recently, I faced an issue while trying to set up Solargraph in VS Code using WSL2 and ASDF for managing Ruby versions. The legacy projects I was working on used Docker, causing conflicts with Ruby versions and resulting in errors when initializing the server. After much research and trial and error, I managed to solve the problem. Here is a step-by-step guide to help other developers who might be facing the same issue.

Disclaimer

The easiest way to resolve Ruby version issues would be to modify the project's .tool-versions file to use a Ruby version compatible with Solargraph. However, in legacy environments, this modification may not be possible due to specific project dependencies or restrictions imposed by the development team. Therefore, this guide provides an alternative solution that does not require changes to the .tool-versions file.

Step-by-Step Solution

Prerequisites

WSL2 installed: Follow the official Microsoft instructions to set up WSL2.
VS Code installed: Download and install VS Code.
Linux distribution on WSL2: For example, Ubuntu.

Step 1: Set Up Ruby on WSL2 with ASDF

Install ASDF: In the WSL2 terminal, run the following commands:

git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.10.0 echo '. $HOME/.asdf/asdf.sh' >> ~/.bashrc echo '. $HOME/.asdf/completions/asdf.bash' >> ~/.bashrc source ~/.bashrc
Add the Ruby plugin and install a Ruby version:

asdf plugin-add ruby https://github.com/asdf-vm/asdf-ruby.git asdf install ruby 3.3.2 # Replace with the necessary version asdf global ruby 3.3.2
Verify the Ruby installation:

ruby -v

Step 2: Install Solargraph

Install Solargraph:

gem install solargraph
Verify the Solargraph installation:

which solargraph

Step 3: Configure VS Code to Use WSL2

Install the "Remote - WSL" Extension: In VS Code, open the Extensions Marketplace and install the Remote - WSL extension.
Open VS Code in WSL2: In the WSL2 terminal, navigate to your project directory and open VS Code:

code .

Step 4: Configure Solargraph in VS Code

Add the configuration in settings.json: In VS Code opened in the WSL2 environment, open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P), search for "Preferences: Open Settings (JSON)" and add the following configuration:
```
{
    "solargraph.commandPath": "/home/your_user/.asdf/shims/solargraph",
    "solargraph.useBundler": false,
    "solargraph.diagnostics": true,
    "solargraph.formatting": true
} 
```
Replace /home/your_user/.asdf/shims/solargraph with the path returned by the which solargraph command.
Restart VS Code: Restart VS Code to apply the new settings.

Troubleshooting

Check permissions and paths: Ensure that the path specified for Solargraph in settings.json is correct and accessible.
VS Code Logs: Check the VS Code logs for more details on the error. Access the logs through the Command Palette (Ctrl+Shift+P -> "Output") and select "Solargraph" from the output menu.

Conclusion

With these steps, you should be able to set up Solargraph in VS Code using the Ruby version managed by ASDF in the WSL2 environment, without the need to modify the project's .tool-versions file. I hope this guide helps solve similar issues you might encounter in your Ruby development environment.

I hope this guide has been helpful! If you have any questions or suggestions, leave a comment below. 🚀

Como Configurar o Solargraph no VS Code com WSL2 para projetos legados

Lucas Luan de Melo — Fri, 21 Jun 2024 12:38:56 +0000

Introdução

Recentemente, enfrentei um problema ao tentar configurar o Solargraph no VS Code enquanto utilizava o WSL2 e o ASDF para gerenciar versões do Ruby. Os projetos legados que eu estava trabalhando usavam Docker, o que causava conflitos com as versões do Ruby e resultava em erros ao inicializar o servidor. Após muita pesquisa e tentativa e erro, consegui resolver o problema. Aqui está um guia passo a passo para ajudar outros desenvolvedores que possam estar enfrentando a mesma situação.

Disclaimer

O caminho mais fácil para resolver problemas de versão de Ruby seria modificar o arquivo .tool-versions do projeto para usar uma versão do Ruby compatível com o Solargraph. No entanto, em ambientes legados, essa modificação pode não ser possível devido a dependências específicas do projeto ou restrições impostas pela equipe de desenvolvimento. Portanto, este guia fornece uma solução alternativa que não requer mudanças no arquivo .tool-versions.

Passo a Passo para Resolver o Problema

Pré-requisitos

WSL2 instalado: Siga as instruções oficiais da Microsoft para configurar o WSL2.
VS Code instalado: Baixe e instale o VS Code.
Distribuição Linux no WSL2: Por exemplo, Ubuntu.

Passo 1: Configure o Ruby no WSL2 com ASDF

Instale o ASDF: No terminal do WSL2, execute os seguintes comandos:

    git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.10.0
    echo '. $HOME/.asdf/asdf.sh' >> ~/.bashrc
    echo '. $HOME/.asdf/completions/asdf.bash' >> ~/.bashrc
    source ~/.bashrc

Adicione o plugin Ruby e instale uma versão do Ruby:

    asdf plugin-add ruby https://github.com/asdf-vm/asdf-ruby.git
    asdf install ruby 3.3.2  # Substitua pela versão necessária
    asdf global ruby 3.3.2

Verifique a instalação do Ruby:

    ruby -v

Passo 2: Instale o Solargraph

Instale o Solargraph:

   gem install solargraph

Verifique a instalação do Solargraph:

    which solargraph

Passo 3: Configure o VS Code para Usar o WSL2

Instale a Extensão "Remote - WSL": No VS Code, abra o Marketplace de Extensões e instale a extensão Remote - WSL.

Abra o VS Code no WSL2: No terminal do WSL2, navegue até o diretório do seu projeto e abra o VS Code:

    code .

Passo 4: Configure o Solargraph no VS Code

Adicione a configuração no settings.json: No VS Code aberto no ambiente WSL2, abra o Command Palette (Ctrl+Shift+P ou Cmd+Shift+P), procure por "Preferences: Open Settings (JSON)" e adicione a seguinte configuração:

    {
        "solargraph.commandPath": "/home/seu_usuario/.asdf/shims/solargraph",
        "solargraph.useBundler": false,
        "solargraph.diagnostics": true,
        "solargraph.formatting": true
    }

Substitua /home/seu_usuario/.asdf/shims/solargraph pelo caminho retornado pelo comando which solargraph.

Reinicie o VS Code: Reinicie o VS Code para aplicar as novas configurações.

Solução de Problemas

Verifique as permissões e caminhos: Certifique-se de que o caminho especificado para o Solargraph no settings.json está correto e acessível.
Logs do VS Code: Verifique os logs do VS Code para mais detalhes sobre o erro. Acesse os logs através do Command Palette (Ctrl+Shift+P -> "Output") e selecione "Solargraph" no menu de saída.

Conclusão

Com esses passos, você deve conseguir configurar o Solargraph no VS Code utilizando a versão do Ruby gerenciada pelo ASDF no ambiente WSL2, sem a necessidade de modificar o arquivo .tool-versions do projeto. Espero que este guia seja útil para resolver problemas semelhantes que você possa encontrar no seu ambiente de desenvolvimento Ruby.