Shopify / Shopify/rubydex

Index class/module references in RBS files

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

Nobody has claimed this yet.

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

Description

https://github.com/Shopify/rubydex/issues/87#issuecomment-3984722767

Add constant references from type name references in RBS files.

class Foo < Array[String]
  include Bar[Integer]

  def foo: () -> Symbol
end

References to some type names like Array in super class and Bar in include are indexed since we need them for resolution. This issue is to add references from other type names in RBS, like type arguments and method type names. (String, Integer, and Symbol in the example.)

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 tracing the existing RBS indexing for superclass and include references described in the issue. Verify the example by checking that type arguments and method type names such as String, Integer, and Symbol are also indexed for resolution.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby, rust
Domain
devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.