Files
gitlab-foss/doc/development/developing_with_solargraph.md
2025-05-30 00:20:13 +00:00

28 lines
1.4 KiB
Markdown

---
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/development/development_processes/#development-guidelines-review.
title: Using Solargraph
---
Gemfile packages [Solargraph](https://github.com/castwide/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`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.solargraph.yml.example) file. Copy the contents of this file to `.solargraph.yml` file for language server to pick this configuration up. As the `.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`](https://github.com/castwide/vscode-solargraph)
- Atom
- GitHub: [`atom-solargraph`](https://github.com/castwide/atom-solargraph)
- Vim
- GitHub: [`LanguageClient-neovim`](https://github.com/autozimu/LanguageClient-neovim)
- Emacs
- GitHub: [`emacs-solargraph`](https://github.com/guskovd/emacs-solargraph)
- Eclipse
- GitHub: [`eclipse-solargraph`](https://github.com/PyvesB/eclipse-solargraph)