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

Review and clean up public API surface types

Đang mở
  • Có gì không ổn?
#6,094 1 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 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
react-native, typescript
Lĩnh vực
api, mobile

Hướng nghiên cứu

Bắt đầu với các export công khai trong index.ts và báo cáo @microsoft/api-extractor được giới thiệu trong #6093. Xem xét từng kiểu export bị bỏ quên được liệt kê và quyết định xem nó có thuộc API công khai hay nên được đánh dấu @internal, bao gồm cả việc xác định liệu export logger có được chủ ý hay không. Hoàn thành khi cả 36 cảnh báo đều có cách giải quyết rõ ràng và bề mặt API phản ánh các quyết định đó.

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

Mô tả

React-Native Task

Context

With the addition of @microsoft/api-extractor in #6093, we now have visibility into the public API surface. The tool reports 36 ae-forgotten-export warnings — types that appear in public function signatures but are not exported from index.ts.

None of these types are documented in the Sentry docs, and no users have reported needing them. TypeScript's structural typing means consumers can pass plain object literals without importing the types explicitly.

What needs reviewing

For each type, decide whether to export it (make it part of the public API) or mark it @internal (explicitly keep it private).

Options/config types (used as integration/function parameters)
  • ReactNativeTracingOptions, ReactNativeTracingState, ReactNativeTracingIntegration
  • ReactNavigationIntegrationOptions, ReactNativeNavigationOptions
  • ReactNativeClientOptions, ReactNativeTransportOptions, BaseReactNativeOptions, ReactNativeWrapperOptions
  • ReactNativeErrorHandlersOptions, LinkedErrorsOptions, BreadcrumbsOptions
  • MobileReplayOptions, MobileReplayIntegration
  • HermesProfilingOptions
  • GraphQLReactNativeIntegrationOptions, SpotlightReactNativeIntegrationOptions, SupabaseReactNativeIntegrationOptions
  • FeedbackFormProps, FeedbackButtonProps, ScreenshotButtonProps, FeedbackFormTheme
  • TouchEventBoundaryProps
  • AppStartIntegration, defaultIdleOptions
Internal/external types (likely should stay unexported)
  • FeedbackFormState, FeedbackIntegration, GlobalErrorBoundaryState — internal component state
  • Replay, ReplayConfiguration — @sentry/browser internals
  • HostComponent, ViewProps — react-native types
  • ExpoAssetInstance, ExpoImageSource, ExpoImageLoadOptions, ExpoImageRef — internal Expo types

Additional items to review

  • logger from @sentry/browser is exported publicly — is this intentional?
Ngôn ngữ chính
TypeScript
Star
1.8k
Fork
369
Merge trung bình
19 giờ 53 phút
Pull request đã merge (30 ngày)
107

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

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 getsentry/sentry-react-native

Tất cả issue của getsentry/sentry-react-native

Issue tương tự

Thêm issue về TypeScript

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.