Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Option to omit private methods from gem RBIs, with a per-gem opt-in

Offen
  • Stimmt etwas nicht?
#2,740 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 4 Tagen

@efegokdemir arbeitet bereits daran.

Seit 14.10.2026.

  • #2743 von @efegokdemir — offen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
30/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
ruby
Bereich
tooling

Rechercherichtung

Start with the Methods listener that skips private methods during tapioca gem and with merge_with_exported_rbi, which the issue says must run after filtering. Read how typed_overrides is parsed from the config to model the new gem options. Done means private_methods: false omits private methods except for gems in private_methods_for, and gems that export their own RBIs keep their private markers after the merge.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Problem

tapioca gem emits every private method it finds. Application code only reaches a gem's private methods through implicit-receiver calls from subclasses, including modules, or DSLs like Rake::DSL, so for most gems these definitions add size and diff churn without affecting type checking.

In a large Rails app (501 gems in the bundle, RBIs generated for 395), 332 of the generated RBIs contain private methods. After stripping private methods from all of them, srb tc passes once private methods are restored for just 9 gems:

  • rake: Rake::DSL#task, #namespace, #desc, called at the top level of every .rake file
  • activerecord: default_scope, transaction_include_any_action?
  • tapioca: Tapioca::Dsl::Compiler#compile_method_parameters_to_rbi, #compile_method_return_type_to_rbi, .all_classes, used by custom DSL compilers
  • rbi: RBI::Visitor#visit_*, which RBI::RBSPrinter overrides with override sigs in the gem's own RBI
  • karafka: Karafka::Instrumentation::Vendors::Datadog::MetricsListener#consumer_tags and #namespaced_metric, overridden by a subclass in another gem
  • super_diff, shoulda-matchers, rubocop, and one internal gem: helpers called from subclasses

Potential reduction

Keeping private methods for those 9 gems and omitting them for the other 386:

Before After Change
Method definitions 198,737 177,402 -10.7%
RBI size, excluding comments 14.3 MB 13.3 MB -7.2%
RBI size, total 38.8 MB 37.0 MB -4.8%
RBI lines, total 1,082,949 1,020,568 -5.8%

Gem upgrades that only touch private methods would also stop producing RBI diffs.

Proposal

A gem option that turns private methods off, plus a list of gems that keep them, similar in shape to typed_overrides:

gem:
  private_methods: false
  private_methods_for:
    - rake
    - activerecord

Defaulting private_methods to true keeps today's output.

Implementation note

We prototyped this with a patch loaded from sorbet/tapioca/require.rb. The filtering has to run after merge_with_exported_rbi. When the Methods listener skips private methods instead, gems that export their own RBIs (pdf-reader, rbi, spoom, prism) declare many of those methods without a private marker, and the merge brings them back as public methods.

Happy to open a PR if this sounds reasonable.

Vorherrschende Sprache
Ruby
Sterne
874
Forks
167
Ø Merge
5 T. 12 Std.
Gemergte PRs (30 T.)
11

Entwicklungsumgebung

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Hat eine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus Shopify/tapioca

Alle Issues in Shopify/tapioca

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.