mirror of
https://github.com/supabase/supabase.git
synced 2026-10-11 20:35:07 +03:00
Ivan Vasilov
7e9f243f51
## Summary - Updates the Cursor rule at `.cursor/rules/studio/queries/RULE.md` to recommend the `queryOptions` pattern from TanStack React Query instead of custom `useXQuery` wrapper hooks - Provides an example implementation by refactoring `thirdPartyAuthIntegrationsQuery` from a `useThirdPartyAuthIntegrationsQuery` hook to `thirdPartyAuthIntegrationsQueryOptions` ## Why this pattern? The `queryOptions` factory pattern from TanStack Query v5 offers several benefits: 1. **Type safety** - Query keys and return types are properly inferred 2. **Reusability** - The same query config can be used with both `useQuery()` in components and `queryClient.fetchQuery()` for imperative fetching 3. **Consistency** - Aligns with TanStack Query's official recommendations 4. **Simplicity** - Removes the need for custom generic wrapper hooks ## Test plan - [ ] Verify the ThirdPartyAuthForm component works correctly with the new pattern - [ ] Check that the Cursor rule provides clear guidance for writing new queries <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Release Notes * **Documentation** * Updated query pattern documentation with revised implementation guidance. * **Refactor** * Updated third-party authentication integrations data fetching mechanism. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Writing components
Where to create your components
- For components that declare the general structure and layout of a page:
/components/layouts/xxx
- For components that are tightly coupled to a specific interface:
/components/interfaces/xxx
- For components that are meant to be reusable across multiple pages:
/components/ui/xxx
- Note: We're gradually moving files out of the
to-be-cleanedfolder into the respective folders as we refactor
Component structure
- If a component has constants and utility methods that are tightly coupled to itself, keep them close to the component and enclose them in a folder with an
index.tsxas an entry point - Otherwise it can just be a file on its own
- For example:
-
components/ui - SampleComponentA - SampleComponentA.tsx - SampleComponentA.constants.ts - SampleComponentA.utils.ts - SampleComponentA.types.ts - index.ts - SampleComponentB.tsx
-
Template for building components
// Declare the prop types of your component
interface ComponentAProps {
sampleProp: string
}
// Name your component accordingly
const ComponentA = ({ sampleProp }: ComponentAProps) => {
return <div>ComponentA: {sampleProp}</div>
}
export default ComponentA