fix(react): specify react peer dependency #206
Conversation
|
|
To view this pull requests documentation preview, visit the following URL: docs.page/invertase/tanstack-query-firebase~206 Documentation is deployed and generated using docs.page. |
There was a problem hiding this comment.
Summary of Changes
Hello @cabljac, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses a dependency management concern by explicitly declaring React as a peer dependency for the packages/react module. This ensures that the module correctly signals its compatibility requirements with React versions 18 and 19, preventing potential issues related to multiple React instances or incompatible versions in consuming applications.
Highlights
- Peer Dependency Update: Explicitly added
reactas a peer dependency inpackages/react/package.json, specifying compatibility with versions^18.0.0and^19.0.0.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request correctly adds react as a peer dependency to the @tanstack-query-firebase/react package, specifying compatibility with both React 18 and 19. This is a valuable improvement for package consumers. I've added one comment regarding ensuring compatibility through testing for the supported React versions. Additionally, please consider updating the documentation in docs/react/index.mdx to reflect that react is now also a peer dependency.
| @@ -45,6 +45,7 @@ | |||
| }, | |||
| "peerDependencies": { | |||
| "@tanstack/react-query": "^5", | |||
| "firebase": "^11.3.0" | |||
| "firebase": "^11.3.0", | |||
| "react": "^18.0.0 || ^19.0.0" | |||
There was a problem hiding this comment.
By adding react: '^18.0.0 || ^19.0.0' as a peer dependency, you are signaling that this package is compatible with React 18. However, the devDependencies only list React 19, which suggests testing might only be performed against React 19. To prevent potential runtime errors for users on React 18, it's recommended to also test the package against a React 18 environment to ensure full compatibility with the declared versions.
No description provided.