Shopify / Shopify/tapioca

Investigation: does Tapioca attempt to reference private constants?

Open
#978 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug good-first-issue question
Dominant language
Ruby
Stars
873
Forks
164
Avg merge
4d 27m
Merged PRs (30d)
9

Description

Tapioca skips generating RBIs for private Sorbet constants. However, we are seeing instances of those constants being referenced in sorbet typechecks on projects with RBI generated by tapioca.

See gist: https://gist.github.com/rafaelfranca/ff4e9ba1fce3a53320268e1b01790d9c

It's not clear if this is a reproduce-able problem or what is causing it -- more investigation needed.

Contributor guide

No contributing guide indexed for this repository

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 linked gist and the reported Sorbet typechecks, then inspect the RBI files generated by Tapioca for references to private constants. Determine whether the behavior is reproducible and identify what causes those references; the investigation is done when the reproduction status and source of the references are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.