solargraph

# Solargraph

[![RSpec](https://github.com/castwide/solargraph/actions/workflows/rspec.yml/badge.svg)](https://github.com/castwide/solargraph/actions/workflows/rspec.yml)

## A Ruby Language Server

Solargraph provides a comprehensive suite of tools for Ruby programming: intellisense, diagnostics, inline documentation, and type checking.

## Online Demo

A web-based demonstration of Solargraph's autocomplete is available at https://solargraph.org/demo.

## Installation

Install the gem from the command line:

    gem install solargraph

Or add it to your Gemfile:

    gem 'solargraph', group: :development

## Using Solargraph

Plug-ins and extensions are available for the following editors:

* **Visual Studio Code**
    * Extension: https://marketplace.visualstudio.com/items?itemName=castwide.solargraph
    * GitHub: https://github.com/castwide/vscode-solargraph

* **Sublime Text**
    * Extension: https://packagecontrol.io/packages/LSP
    * GitHub: https://github.com/sublimelsp/LSP
    * Instructions: https://lsp.sublimetext.io/language_servers/#solargraph

* **Vim**
    * Github: `nvim-lspconfig`, https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#solargraph
    * GitHub: `LanguageClient-neovim`, https://github.com/autozimu/LanguageClient-neovim
    * GitHub: `coc`, https://github.com/neoclide/coc-solargraph
    * GitHub: `Vim-EasyComplete`, https://github.com/jayli/vim-easycomplete

* **Emacs**
    * GitHub: `eglot.el`, https://github.com/joaotavora/eglot
    * GitHub: `lsp-mode.el`, https://github.com/emacs-lsp/lsp-mode

* **Eclipse**
    * Plugin: https://marketplace.eclipse.org/content/ruby-solargraph
    * GitHub: https://github.com/PyvesB/eclipse-solargraph

### Configuration

Solargraph's behavior can be controlled via optional [configuration](https://solargraph.org/guides/configuration) files. The highest priority file is a `.solargraph.yml` file at the root of the project. If not present, any global configuration at `~/.config/solargraph/config.yml` will apply. The path to the global configuration can be overridden with the `SOLARGRAPH_GLOBAL_CONFIG` environment variable.

Use `bundle exec solargraph config` to create a configuration file.

### Plugins

Solargraph supports [plugins](https://solargraph.org/guides/plugins) that implement their own Solargraph features, such as diagnostics reporters and conventions to provide LSP features and type-checking, e.g. for frameworks which use metaprogramming and/or DSLs.

For better Rails support, please consider using [solargraph-rails](https://github.com/iftheshoefritz/solargraph-rails/)

The RSpec framework is supported via [solargraph-rspec](https://github.com/lekemula/solargraph-rspec/)

### Gem Support

**Note: Before version 0.53.0, it was recommended to run `yard gems` periodically or automate it with `yard config` to ensure that Solargraph had access to gem documentation. These steps are no longer necessary. Solargraph maintains its own gem documentation cache independ