Shopify / Shopify/ruby-lsp-rails

Feature request: show full route on hover in routes.rb

Open
#602 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I am not sure this is possible, but it would be great to be able to see the whole route like you can see on a controller action (ref) when you hover a route in a routes.rb file 👇

Image

If you have a small routes.rb file, it may be overkill, but on a bigger routes.rb file, when you have multiple resource :settings that are nested in different places, it is tough to find out on which one you're and try to figure out what the route is like in your head.

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 with the routes.rb hover behavior and compare it with the existing Go to Controller Action route behavior described in the linked Rails add-on documentation. Trace how route context is presented today, then define completion as showing the full route when hovering routes, including nested duplicate resources such as multiple settings routes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.