Shopify / Shopify/ruby-lsp-rails

Possibility of using the gem in a project with isolate_namespace RoR engines

Open
#683 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
688
Forks
44
PR merge metrics
No merged PRs in 30d

Description

I am using the ruby-lsp-rails gem in a Ruby on Rails 8.0 project where engines are located in the project's /engines realative path.

When working in Visual Studio Code, I prefer to edit all project files simultaneously, which means I need engine support within the gem. I have added the "Jump to view" and "jump to route" lenses to the controllers in my fork at https://github.com/apaokin/ruby-lsp-rails (although "jump to view" feature is heavily hardcoded now) , but I would like to have this functionality in the main gem.

Is support for Rails engines planned? Should I contribute my work to the main repository?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing ruby-lsp-rails gem alongside the linked fork, focusing on its hardcoded “Jump to view” and “Jump to route” lenses and how isolate_namespace Rails engines are discovered. Done means the desired engine support is defined and the relevant functionality works from Visual Studio Code across project and engine files.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
backend, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.