Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#2,740 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

@efegokdemir đang làm issue này rồi.

Từ ngày 14/10/2026.

  • #2743 của @efegokdemir — đang mở

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
30/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
ruby
Lĩnh vực
tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Ruby
Star
874
Fork
169
Merge trung bình
3 ngày 6 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Shopify/tapioca

Tất cả issue của Shopify/tapioca

Issue tương tự

Thêm issue về Ruby

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.