A Ruby language server.
Clone or download
Latest commit c6d742b Jan 16, 2019

README.md

Solargraph

IDE tools for the Ruby language.

Solargraph is a set of tools to integrate Ruby code completion and inline documentation into IDEs.

Online Demo

A web-based demonstration of Solargraph is available at http://solargraph.org/demo.

Installation

Solargraph is available as a Ruby gem:

gem install solargraph

Using Solargraph

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

Gem Support

Solargraph is capable of providing code completion and documentation for gems that have YARD documentation. You can make sure your gems are documented by running yard gems from the command line. (The first time you run it might take a while if you have a lot of gems installed).

When editing code, a require call that references a gem will pull the documentation into the code maps and include the gem's API in code completion and intellisense.

More Information

See http://solargraph.org/tips for more tips on using Solargraph with an editor.

How It Works

Solargraph uses parser for code analysis and YARD for API documentation.

Using the solargraph Executable

The gem includes an executable that provides access to the library's features. For code completion, IDEs will typically integrate using solargraph stdio or solargraph socket.

Language Server Protocol

The language server protocol is the recommended way for integrating Solargraph into editors and IDEs. Clients can connect using either stdio or TCP. See LANGUAGE_SERVER.md for more information.

Standalone Suggest

The suggest subcommand provides an interface to request suggestions without the need for a server. When executed, it accepts the parameters for a suggestion request, returns the suggestions in JSON format, and exits.

Warning: The suggest subcommand is a candidate for deprecation. It will either change drastically or not exist in a future version.

Updating the Core Documentation

The Solargraph gem ships with documentation for Ruby 2.2.2. As of gem version 0.15.0, there's an option to download additional documentation for other Ruby versions from the command line.

$ solargraph list-cores      # List the installed documentation versions
$ solargraph available-cores # List the versions available for download
$ solargraph download-core   # Install the best match for your Ruby version
$ solargraph clear-cores     # Clear the documentation cache

Solargraph and Bundler

If you're using the Solargraph language server with a project that uses Bundler, the most comprehensive way to use your bundled gems is to bundle Solargraph.

In the Gemfile:

gem 'solargraph', group: :development

Run bundle install and use bundle exec yard gems to generate the documentation. This process documents cached or vendored gems, or even gems that are installed from a local path.

In order to access the gems in your project, you'll need to start the language server with Bundler. In VS Code, there's a solargraph.useBundler option. Other clients will vary, but the command you probably want to run is bundle exec solargraph socket or bundle exec solargraph stdio.

Runtime Suggestions (EXPERIMENTAL)

As of gem version 0.15.0, Solargraph includes experimental support for plugins.

The Runtime plugin enhances code completion by querying namespaces for method names in a subprocess. If it finds any undocumented or "magic" methods, they get added to the suggestions.

This feature is currently disabled by default. If you'd like to try it, you can enable it by setting the plugins section in your project's .solargraph.yml file:

plugins:
- runtime