developing_with_solargraph.md

stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review.

Using Solargraph

Gemfile packages Solargraph language server for additional IntelliSense and code formatting capabilities with editors that support it.

Example configuration for Solargraph can be found in .solargraph.yml.example file. Copy the contents of this file to .solargraph.yml file for language server to pick this configuration up. Since .solargraph.yml configuration file is ignored by Git, it's possible to adjust configuration according to your needs.

Refer to particular IDE plugin documentation on how to integrate it with Solargraph language server:

• Visual Studio Code

  • GitHub: vscode-solargraph

• Atom

  • GitHub: atom-solargraph

• Vim

  • GitHub: LanguageClient-neovim

• Emacs

  • GitHub: emacs-solargraph

• Eclipse

  • GitHub: eclipse-solargraph