IDE tools for the Ruby language.
This library is still in early development.
Solargraph is a set of tools to integrate Ruby code completion and inline documentation into IDEs. The first supported IDE is Visual Studio Code.
Solargraph is available as a Ruby gem:
gem install solargraph
To use it with Visual Studio Code, install the Solargraph extension.
Solargraph uses parser for code analysis and YARD for API documentation.
The gem includes an executable that provides access to the library's features. For code completion, IDEs will typically integrate using solargraph server or solargraph suggest.
The server subcommand runs a local web server that listens for suggestion requests.
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.
Documentation for Solargraph integration is forthcoming. In the meantime, refer to the VS Code extension source for an example.