Shopify / Shopify/rubydex

Index global variable references

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

Nobody has claimed this yet.

medium
Dominant language
Rust
Stars
355
Forks
24
Avg merge
2d 6h
Merged PRs (30d)
17

Description

Not for the MVP: the Ruby LSP doesn't support global variable references yet.

For the long term though, we would like to be able to provide find references and rename for global variables. Even easier than other types of variables, global variables have zero ambiguity in their references. If we see a reference to $var, this can only refer to $var (fully qualifying the name is trivial).

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

No files, tests, or entry points are named. Start by locating the implementation of find references and rename for other variable kinds in the Ruby LSP or static-analysis code, then identify how global variable references fit. Done means global variables such as $var support both operations without ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby, rust
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.