Uh oh!
There was an error while loading. Please reload this page.
fix(expo): remove iOS codegen warnings from native auth views - #8800
Conversation
🦋 Changeset detectedLatest commit: 0063d5b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
The latest updates on your projects. Learn more about Vercel for GitHub.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Repository UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthroughThree Expo native view spec files replace react-native internals and ChangesNative Component Refactoring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/expo@clerk/expo-passkeys@clerk/express@clerk/fastify@clerk/hono@clerk/localizations@clerk/nextjs@clerk/nuxt@clerk/react@clerk/react-router@clerk/shared@clerk/tanstack-react-start@clerk/testing@clerk/ui@clerk/upgrade@clerk/vuecommit: |
API Changes Report
Summary
No API Changes DetectedAll packages have stable APIs with no detected changes. Report generated by Break Check Last ran on |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
packages/expo/src/specs/NativeClerkUserProfileView.ts (1)
13-13: ⚡ Quick winConsider adding JSDoc if this component appears in generated reference docs.
Similar to the other spec files, if
NativeClerkUserProfileViewis part of the public/reference-facing API, it should include JSDoc comments describing props likeonProfileEvent. However, if this is strictly internal infrastructure, documentation may not be necessary.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/expo/src/specs/NativeClerkUserProfileView.ts` at line 13, Add a JSDoc comment above the default export to document the native component and its props (reference the generic type NativeProps and the event prop onProfileEvent) so generated reference docs include a description; include a short description of the component's purpose, list key props (e.g., onProfileEvent and any required props from NativeProps), and annotate event payload shape if applicable.Source: Coding guidelines
packages/expo/src/specs/NativeClerkUserButtonView.ts (1)
8-8: ⚡ Quick winConsider adding JSDoc if this component appears in generated reference docs.
Similar to the other spec files, if
NativeClerkUserButtonViewis part of the public/reference-facing API, it should include JSDoc comments. However, if this is strictly internal infrastructure, documentation may not be necessary.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/expo/src/specs/NativeClerkUserButtonView.ts` at line 8, Add JSDoc for the native component export to document its purpose and props for generated reference docs: insert a JSDoc block above the export describing the component (ClerkUserButtonView), its public usage, and the shape of NativeProps (mention any important fields), and note whether it is public or internal; reference the exported default requireNativeComponent call and the NativeProps type so the doc generator picks up the component and its props.Source: Coding guidelines
packages/expo/src/specs/NativeClerkAuthView.ts (1)
14-14: ⚡ Quick winConsider adding JSDoc if this component appears in generated reference docs.
This exported component lacks JSDoc documentation. If
NativeClerkAuthViewis intended to be part of the public/reference-facing API that generates Clerk Docs, it should include JSDoc comments describing its purpose, props (particularlyonAuthEvent), and usage. However, if this is strictly an internal spec file not exposed to customers, documentation may not be necessary.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/expo/src/specs/NativeClerkAuthView.ts` at line 14, Add a JSDoc block above the default export of the native component created by requireNativeComponent<NativeProps>('ClerkAuthView') that briefly describes the purpose of the ClerkAuthView native component, lists and describes the NativeProps (call out the onAuthEvent prop and its event payload/shape), and shows a short usage summary for consumers; place the JSDoc immediately above the export so generated reference docs will include the description for ClerkAuthView and its props.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/expo/src/specs/NativeClerkAuthView.ts`:
- Around line 3-4: Replace the deep import of BubblingEventHandler from
'react-native/Libraries/Types/CodegenTypes' with an import from the root
react-native module and update type references: import { CodegenTypes } from
'react-native' and change any BubblingEventHandler usages to
CodegenTypes.BubblingEventHandler (e.g., where BubblingEventHandler is
referenced in NativeClerkAuthView typings), removing the eslint-disable comment
tied to the deep import.
In `@packages/expo/src/specs/NativeClerkUserButtonView.ts`:
- Around line 4-6: The existing comment claiming "Codegen requires an interface
declaration here" is outdated because the implementation switched from
codegenNativeComponent to requireNativeComponent; update or remove it: either
remove the comment entirely if an interface is no longer required, or replace it
with a brief, accurate note explaining why the interface-style declaration is
still used (e.g., "Keep as interface rather than type alias to satisfy React
Native requireNativeComponent typings for NativeProps"), and ensure the
declaration name NativeProps and its use in NativeClerkUserButtonView remain
unchanged.
---
Nitpick comments:
In `@packages/expo/src/specs/NativeClerkAuthView.ts`:
- Line 14: Add a JSDoc block above the default export of the native component
created by requireNativeComponent<NativeProps>('ClerkAuthView') that briefly
describes the purpose of the ClerkAuthView native component, lists and describes
the NativeProps (call out the onAuthEvent prop and its event payload/shape), and
shows a short usage summary for consumers; place the JSDoc immediately above the
export so generated reference docs will include the description for
ClerkAuthView and its props.
In `@packages/expo/src/specs/NativeClerkUserButtonView.ts`:
- Line 8: Add JSDoc for the native component export to document its purpose and
props for generated reference docs: insert a JSDoc block above the export
describing the component (ClerkUserButtonView), its public usage, and the shape
of NativeProps (mention any important fields), and note whether it is public or
internal; reference the exported default requireNativeComponent call and the
NativeProps type so the doc generator picks up the component and its props.
In `@packages/expo/src/specs/NativeClerkUserProfileView.ts`:
- Line 13: Add a JSDoc comment above the default export to document the native
component and its props (reference the generic type NativeProps and the event
prop onProfileEvent) so generated reference docs include a description; include
a short description of the component's purpose, list key props (e.g.,
onProfileEvent and any required props from NativeProps), and annotate event
payload shape if applicable.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: f7ab2baf-8008-4b44-b1f3-2c6d895b397a
📒 Files selected for processing (4)
.changeset/expo-native-view-codegen-warning.mdpackages/expo/src/specs/NativeClerkAuthView.tspackages/expo/src/specs/NativeClerkUserButtonView.tspackages/expo/src/specs/NativeClerkUserProfileView.ts
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Summary
requireNativeComponentinstead ofcodegenNativeComponentrequireNativeView@clerk/expowarning fixFixed warnings
During a clean iOS run of the native-components Expo quickstart, React Native logged these runtime warnings after launch:
Those warnings were coming from the iOS JS specs calling
codegenNativeComponentfor views that are registered through the existing legacyRCTViewManagerpath. The patched specs now resolve those same native view managers withrequireNativeComponent, which removes the false codegen warning while preserving the native component lookup.Testing
@clerk/expopackage and overlaid it intoNativeComponentQuickstartwithout changing quickstart tracked filesnpx expo prebuild --clean --platform iossuccessfullynpx expo run:ios --device "iPhone Air + Watch" --port 8081successfully with0 error(s)AuthViewin the simulator and confirmed theCodegen didn't run for Clerk...warnings no longer appear after launch or after rendering the native auth viewSummary by CodeRabbit