getsentry / getsentry/sentry-react-native

Audit RN-specific public exports against documentation

Offen
#6,095 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Docs React-Native
Vorherrschende Sprache
TypeScript
Sterne
1.8k
Forks
366
Ø Merge
1 T. 5 Std.
Gemergte PRs (30 T.)
93

Beschreibung

## Context

With `@microsoft/api-extractor` added in #6093, we have a complete list of the SDK's public API surface. This issue tracks cross-referencing React Native-specific exports against https://docs.sentry.io/platforms/react-native/ to find undocumented APIs or docs referencing removed APIs.

Only RN-specific exports — re-exports from `@sentry/core`, `@sentry/react`, and `@sentry/browser` are out of scope (those are documented by the JS SDK).

## RN-specific exports to check

### Core
- `init`, `wrap`, `close`, `flush`, `withScope`, `nativeCrash`, `crashedLastRun`, `appLoaded`
- `ReactNativeClient`, `ReactNativeOptions`
- `SDK_NAME`, `SDK_VERSION`
- `getDataFromUri`

### Integrations
- `reactNativeTracingIntegration`, `reactNavigationIntegration`, `reactNativeNavigationIntegration`
- `reactNativeErrorHandlersIntegration`
- `mobileReplayIntegration`, `browserReplayIntegration`
- `feedbackIntegration`, `FeedbackForm`, `FeedbackButton`, `showFeedbackForm`, `showFeedbackButton`, `hideFeedbackButton`, `enableFeedbackOnShake`, `disableFeedbackOnShake`
- `hermesProfilingIntegration`
- `appStartIntegration`, `nativeFramesIntegration`, `stallTrackingIntegration`
- `breadcrumbsIntegration`, `nativeLinkedErrorsIntegration`
- `screenshotIntegration`, `viewHierarchyIntegration`
- `deviceContextIntegration`, `eventOriginIntegration`, `nativeReleaseIntegration`, `sdkInfoIntegration`, `reactNativeInfoIntegration`, `modulesLoaderIntegration`
- `debugSymbolicatorIntegration`, `appRegistryIntegration`
- `spotlightIntegration`
- `graphqlIntegration`, `supabaseIntegration`, `deeplinkIntegration`
- `expoContextIntegration`, `expoConstantsIntegration`, `expoUpdatesListenerIntegration`
- `userInteractionIntegration`, `timeToDisplayIntegration`
- `logEnricherIntegration`, `primitiveTagIntegration`
- `createNativeFramesIntegrations`, `createReactNativeRewriteFrames`

### Tracing
- `sentryTraceGesture`
- `TimeToInitialDisplay`, `TimeToFullDisplay`, `createTimeToInitialDisplay`, `createTimeToFullDisplay`
- `startTimeToInitialDisplaySpan`, `startTimeToFullDisplaySpan` (deprecated)
- `startIdleNavigationSpan`, `startIdleSpan`, `getDefaultIdleNavigationSpanOptions`
- `getCurrentReactNativeTracingIntegration`, `getReactNativeTracingIntegration`

### Components
- `TouchEventBoundary`, `withTouchEventBoundary`
- `GlobalErrorBoundary`, `withGlobalErrorBoundary`
- `Mask`, `Unmask`

### Expo helpers
- `wrapExpoRouter`, `wrapExpoImage`, `wrapExpoAsset`

### Types
- `GlobalErrorBoundaryProps`, `TimeToDisplayProps`, `NativeLogEntry`
- `ExpoRouter`, `ExpoImage`, `ExpoAsset`

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit der vollständigen Liste der öffentlichen APIs, die nach dem Hinzufügen von @microsoft/api-extractor erstellt wird, und gleiche anschließend die darin aufgeführten React Native-spezifischen Exporte mit https://docs.sentry.io/platforms/react-native/ ab. Schließe Re-Exports aus @sentry/core, @sentry/react und @sentry/browser aus; die Aufgabe ist abgeschlossen, wenn nicht dokumentierte RN-Exporte und Dokumentationsverweise auf entfernte APIs identifiziert und bearbeitet wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react-native, typescript
Bereich
documentation, mobile-dev
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

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