Skip to content
💎 Eclipse Ruby plugin based on the Solargraph language server.
Java Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.mvn
eclipse-solargraph-feature
eclipse-solargraph-plugin
eclipse-solargraph-updatesite
images
.gitignore
.project
LICENSE
README.md
pom.xml

README.md

Eclipse Solargraph

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


Ruby edition with syntax highlighting and autocomplete. Many other features are also available.

Features at a glance

  • Rich syntax highlighting
  • Code completion
  • Rename refactoring
  • Find references
  • Jump to declaration
  • Code outline
  • Code folding
  • Documentation hovers, see the Solargraph readme for more information
  • Run files as Ruby programs
  • Run bundle install on Gemfiles and gem build on gemspec files
  • Various other features part of the Language Server Protocol

Check out what's new in the latest releases!

Getting started

💿 Plugin installation

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

Drag to your running Eclipse workspace. Requires Eclipse Marketplace Client

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

🔧 Setting your own working copy of the project

  • Download the RCP and RAP Developers version of Eclipse.
  • Clone or download this repository. You can also create your own fork by clicking on the Fork icon on the top right of this page.
  • 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.
  • 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.

Contributing

$ code

Want to make this plugin better, faster, stronger? Contributions are more than welcome, open a pull request and share your code! Simply fork the repository by clicking on the icon on the top right of this page and you're ready to go!

💬 Support

Thought of a cool idea? Found a problem or need some help? Simply open an issue!

⭐️ Thanks

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

Acknowledgements

The following projects are used by this plugin:

  • Solargraph by castwide: underlying language server (MIT License) and adapted marketplace logo (CC BY-SA 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).

License

Eclipse Public License - v 2.0

You can’t perform that action at this time.