getsentry / getsentry/sentry-react-native

Audit RN-specific public exports against documentation

Ouverte
#6,095 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Docs React-Native
Langage dominant
TypeScript
Étoiles
1.8k
Forks
367
Merge moyen
1 j 6 h
PR mergées (30 j)
94

Description

## 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`

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la liste complète des API publiques produite après l’ajout de @microsoft/api-extractor, puis confrontez les exports spécifiques à React Native qui y sont répertoriés avec https://docs.sentry.io/platforms/react-native/. Excluez les réexports de @sentry/core, @sentry/react et @sentry/browser ; le travail est terminé lorsque les exports RN non documentés et les références de la documentation à des API supprimées ont été identifiés et traités.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
react-native, typescript
Domaine
documentation, mobile-dev
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
52/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.