Shopify / Shopify/tapioca

Show that Tapioca is not stuck

Open
#1,362 0 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Ruby
Stars
873
Forks
164
Avg merge
4d 27m
Merged PRs (30d)
9

Description

For some (very large) gems Tapioca can take a while to generate the RBI file.

While Tapioca is processing thousands of constants and methods, from the user point of view it may seem like nothing is happening and Tapioca is stuck:

Compiled previous_gem
      create  sorbet/rbi/gems/previous_gem@1.0.0.rbi
# Nothing for a few minutes...

We should change the output to indicate that something is indeed happening a reassure the user that Tapioca isn't stuck.

Maybe we could display which constant/property we're currently compiling:

Compiling RBI for gem@1.0.0
  constant1 # this line would be refreshed with the current thing being compiled to avoid too much verbosity
            # then when the file is finished we can replace it by `created  sorbet/rbi/gems/previous_gem@1.0.0.rbi` 

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 by tracing the CLI output during RBI generation for large gems, especially around the point where thousands of constants and methods are compiled. Add visible progress that reassures users without excessive verbosity, and preserve a final message showing that the RBI file was created.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli, 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.