Eclipse Solargraph

Ruby plugin combining the powers of the Eclipse IDE and the Solargraph language server!

_{Left: Ruby edition with syntax highlighting, autocomplete, docs, outline, references search and many other features! Right: debugging session!}

💎 Features at a glance

• Rich syntax highlighting and code folding
• Code completion
• Documentation hovers
• Rename refactoring
• Find references
• Jump to declarations
• Code outline
• Run files as Ruby scripts with customisable launch configurations
• Run bundle install on Gemfiles and gem build on gemspec files
• Various other features part of the Language Server Protocol
• Experimental debugger

Check out what's new in the latest releases!

💿 Plugin installation

You can download and install the plugin via the Eclipse Marketplace, or simply drag the below button to your running Eclipse workspace:

Alternatively, head to the update site and follow the instructions listed there.

Once installed, the plugin will simply kick in when opening any Ruby file in Eclipse; there is no Ruby-specific project type or perspective.

✨ Tips and tricks

To improve code completion and intellisense, it is recommended to generate YARD documentation for your gems (run yard gems in a terminal).

You can fine-tune Solargraph's behaviour on a per-project basis by creating a .solargraph.yml configuration file.

⭐ Support and feedback

Found a problem or need some help? Simply open an issue!

Find the project useful or interesting? Star the repository by clicking on the icon on the top right of this page!

💻 Code contributions

Want to make this plugin better, faster, stronger? Contributions are more than welcome, open a pull request and share your code!

Setting up your own working copy of the project is easy:

• Download the RCP and RAP Developers version of Eclipse.
• Fork the repository by clicking on the Fork icon on the top right of this page and clone it locally.
• In Eclipse, go to File -> Import... -> General -> Existing Projects into Workspace.
• In the Select root directory field, indicate the location where you checked out the eclipse-solargraph repository.
• Ensure Search for nested projects is enabled, select all projects in the Projects field and click Finish.
• Open eclipse-solargraph-target-platform.target and click Set as Active Target Platform.
• You're ready to go! You can now either launch an instance of Eclipse running the plugin by right-clicking on the plugin project and selecting Run As -> Eclipse Application, or you can export a plugin archive file by selecting Export -> Deployable plug-ins and fragments.

⚖️ License and acknowledgements

Eclipse Solargraph licensed under Eclipse Public License - v 2.0.

The following projects are used by this plugin:

• Solargraph by castwide: underlying language server (MIT License) and adapted marketplace logo (CC BY-SA License).
• Readapt by castwide: debugger (MIT License).
• LSP4E: Language Server Protocol support in the Eclipse IDE (Eclipse Public License).
• VS Code: TextMate language configuration (MIT License).
• TM4E: TextMate support in the Eclipse IDE (Eclipse Public License).
• Ruby: launch shortcut logo (Creative Commons License).