{"id":16932101,"url":"https://github.com/pyvesb/eclipse-solargraph","last_synced_at":"2025-03-17T07:32:11.495Z","repository":{"id":35710468,"uuid":"183298549","full_name":"PyvesB/eclipse-solargraph","owner":"PyvesB","description":":gem: Ruby development tools for Eclipse.","archived":false,"fork":false,"pushed_at":"2024-07-27T09:37:50.000Z","size":1845,"stargazers_count":31,"open_issues_count":1,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-27T20:26:47.295Z","etag":null,"topics":["debugger","eclipse","eclipse-plugin","editor","language-server","language-server-protocol","lsp","ruby"],"latest_commit_sha":null,"homepage":"https://marketplace.eclipse.org/content/ruby-solargraph","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PyvesB.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-24T20:01:45.000Z","updated_at":"2024-12-07T16:19:00.000Z","dependencies_parsed_at":"2024-07-27T09:53:40.413Z","dependency_job_id":null,"html_url":"https://github.com/PyvesB/eclipse-solargraph","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyvesB%2Feclipse-solargraph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyvesB%2Feclipse-solargraph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyvesB%2Feclipse-solargraph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyvesB%2Feclipse-solargraph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyvesB","download_url":"https://codeload.github.com/PyvesB/eclipse-solargraph/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243852425,"owners_count":20358270,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["debugger","eclipse","eclipse-plugin","editor","language-server","language-server-protocol","lsp","ruby"],"created_at":"2024-10-13T20:45:34.778Z","updated_at":"2025-03-17T07:32:11.121Z","avatar_url":"https://github.com/PyvesB.png","language":"Java","readme":"# Eclipse Solargraph \n\u003ca href=\"https://marketplace.eclipse.org/content/ruby-solargraph\"\u003e\n\u003cimg src =\"https://img.shields.io/eclipse-marketplace/v/ruby-solargraph.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://marketplace.eclipse.org/content/ruby-solargraph\"\u003e\n\u003cimg src =\"https://img.shields.io/eclipse-marketplace/favorites/ruby-solargraph.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://marketplace.eclipse.org/content/ruby-solargraph\"\u003e\n\u003cimg src =\"https://img.shields.io/eclipse-marketplace/dt/ruby-solargraph.svg\" /\u003e\n\u003c/a\u003e\n\n**Ruby development tools combining the powers of the Eclipse IDE and the Solargraph language server!**\n\n\u003cp align=\"center\" style=\"font-size:6px;\"\u003e\n\u003cimg src =\"https://github.com/PyvesB/eclipse-solargraph/blob/master/images/editor.png?raw=true\" width=\"32%\" /\u003e\n\u003cimg src =\"https://github.com/PyvesB/eclipse-solargraph/blob/master/images/bundle-install.png?raw=true\" width=\"32%\" /\u003e\n\u003cimg src =\"https://github.com/PyvesB/eclipse-solargraph/blob/master/images/debugger.png?raw=true\" width=\"32%\" /\u003e\n\u003cbr /\u003e\n\u003ci\u003e\u003csub\u003eLeft: syntax highlighting, completions, docs, code outline, references, diagnostics and more! Middle: bundle install on Gemfile. Right: debugger with interactive console.\u003c/sub\u003e\u003c/i\u003e\n\u003c/p\u003e\n\n## :gem: Features at a glance\n\n* Rich syntax highlighting and code folding\n* Code completion\n* Documentation hovers\n* Rename refactoring\n* Find references and mark occurrences\n* Jump to declarations\n* Code outline\n* Compiler warnings based on Rubocop rules\n* Code formatter\n* Interactive debugger\n* Run Ruby scripts with customisable launch configurations\n* Run `bundle install` on Gemfiles and `gem build` on gemspec files\n* Basic support for web development with ERB Rails files\n* Various other features part of the Language Server Protocol\n\nCheck out what's new in the [latest releases](https://github.com/PyvesB/eclipse-solargraph/releases)!\n\n## :cd: Plugin installation\n\nYou can install the plugin via **[the Eclipse Marketplace](https://marketplace.eclipse.org/content/ruby-solargraph/)**, or simply drag the following button to your running Eclipse window:\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=4611382\" class=\"drag\" title=\"Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client\"\u003e\u003cimg style=\"width:80px;\" typeof=\"foaf:Image\" class=\"img-responsive\" src=\"https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.svg\" alt=\"Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nAlternatively, head to the [update site](https://pyvesb.github.io/eclipse-solargraph/) and follow the instructions listed there.\n\nOnce installed, the plugin will simply kick in when opening any Ruby file in Eclipse; there is no Ruby-specific project type or perspective.\n\n## :date: Compatibility\n\nThis plugin requires Java 11 or more recent.\n\nThe aim is to provide support for all Eclipse releases that are at **up to two years old**. Versions older than that may be dropped at any point without notice. That being said, the plugin should currently still work with Eclipse versions as old as **2019-03** (4.11).\n\n## :sparkles: Tips and tricks\n\n* You can fine-tune Solargraph's behaviour by [creating a .solargraph.yml configuration file](https://solargraph.org/guides/configuration).\n* Similarly, you can fine-tune the code formatting and compiler warnings with a .rubocop.yml file.\n* To improve code completion and intellisense, it is recommended to generate YARD documentation for your gems (run `yard gems` in a terminal).\n* For web development on ERB files, it is recommended to also install the [Wild Web Developer](https://github.com/eclipse/wildwebdeveloper) plugin.\n\n## :star: Support and feedback\n\nFound a problem or need some help? Simply open an [**issue**](https://github.com/PyvesB/eclipse-solargraph/issues)!\n\nFind the project useful or interesting? **Star** the repository by clicking on the icon on the top right of this page!\n\n## :computer: Code contributions\n\nWant to make this plugin better, faster, stronger? Contributions are more than welcome, open a **pull request** and share your code!\n\nSetting up your own working copy of the project is easy:\n* Download the [RCP and RAP Developers](https://eclipse.org/downloads/eclipse-packages/) version of Eclipse.\n* Fork the repository by clicking on the *Fork* icon on the top right of this page and clone it locally.\n* In Eclipse, go to `File` -\u003e `Import...` -\u003e `General` -\u003e `Existing Projects into Workspace`.\n* In the `Select root directory` field, indicate the location where you checked out the eclipse-solargraph repository.\n* Ensure `Search for nested projects` is enabled, select all projects in the `Projects` field and click `Finish`.\n* Open `eclipse-solargraph-target-platform.target` and click `Set as Active Target Platform`.\n* You're ready to go! You can now either launch an Eclipse instance by right-clicking on the plugin project and selecting `Run As` -\u003e `Eclipse Application`, or you can export a plugin archive file by selecting `Export` -\u003e `Deployable plug-ins and fragments`.\n\n## :balance_scale: License and acknowledgements\n\nEclipse Solargraph licensed under Eclipse Public License - v 2.0.\n\nThe following projects are used by this plugin:\n* [Solargraph](http://solargraph.org/) by [castwide](https://github.com/castwide): underlying language server (MIT License) and adapted marketplace logo (CC BY-SA License).\n* [Readapt](https://github.com/castwide/readapt) by [castwide](https://github.com/castwide): debugger (MIT License).\n* [LSP4E](https://github.com/eclipse/lsp4e): Language Server Protocol support in the Eclipse IDE (Eclipse Public License).\n* [Ruby LSP](https://github.com/Shopify/ruby-lsp) by Shopify: Ruby language grammars (MIT License).\n* [Ruby](https://www.ruby-lang.org): launch shortcut logo (Creative Commons License).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyvesb%2Feclipse-solargraph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpyvesb%2Feclipse-solargraph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpyvesb%2Feclipse-solargraph/lists"}