Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Shopify/ruby-lsp-rails
A Ruby LSP addon for Rails
https://github.com/Shopify/ruby-lsp-rails
Last synced: 16 days ago
JSON representation
A Ruby LSP addon for Rails
- Host: GitHub
- URL: https://github.com/Shopify/ruby-lsp-rails
- Owner: Shopify
- License: mit
- Created: 2023-03-31T13:34:24.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T21:41:18.000Z (3 months ago)
- Last Synced: 2024-04-14T09:45:32.564Z (2 months ago)
- Language: Ruby
- Homepage: https://shopify.github.io/ruby-lsp-rails/
- Size: 9.9 MB
- Stars: 475
- Watchers: 114
- Forks: 18
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Lists
- awesome-sorbet - ruby-lsp-rails
- awesome-stars - Shopify/ruby-lsp-rails - A Ruby LSP addon for Rails (Ruby)
- awesome-stars - Shopify/ruby-lsp-rails - A Ruby LSP addon for Rails (Ruby)
README
[](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)
# Ruby LSP Rails
Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra Rails editor features, such as:
* Hover over an ActiveRecord model to reveal its schema.
* Run or debug a test by clicking on the code lens which appears above the test class, or an individual test.
* Navigate to associations, validations, callbacks and test cases using your editor's "Go to Symbol" feature, or outline view.
* Jump to the definition of callbacks using your editor's "Go to Definition" feature.
* Jump to the declaration of a route.
## Installation
If you haven't already done so, you'll need to first [set up Ruby LSP](https://github.com/Shopify/ruby-lsp#usage).
As of v0.3.0, Ruby LSP will automatically include the Ruby LSP Rails addon in its custom bundle when a Rails app is detected.
There is no need to add the gem to your bundle.
## Documentation
See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-depth details about the
[supported features](https://shopify.github.io/ruby-lsp-rails/RubyLsp/Rails.html).
## How Runtime Introspection Works
LSP tooling is typically based on static analysis, but `ruby-lsp-rails` actually communicates with your Rails app for
some features.
When Ruby LSP Rails starts, it spawns a `rails runner` instance which runs
[`server.rb`](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb).
The addon communicates with this process over a pipe (i.e. `stdin` and `stdout`) to fetch runtime information about the application.
When extension is stopped (e.g. by quitting the editor), the server instance is shut down.
> [!NOTE]
> Prior to v0.3.0, `ruby-lsp-rails` used a different approach which involved mounting a Rack application within the Rails app.
> That approach was brittle and susceptible to the application's configuration, such as routing and middleware.
## Contributing
See [CONTRIBUTING.md](https://github.com/Shopify/ruby-lsp-rails/blob/main/CONTRIBUTING.md)
## License
The gem is available as open source under the terms of the
[MIT License](https://github.com/Shopify/ruby-lsp-rails/blob/main/LICENSE.txt).