firestoreodm-flutter
firestoreodm-flutter copied to clipboard
Feat/compatibilty_with_riverpod3
- Changed generated file postfix from .g.dart to .firebase.dart for better compatibility with Riverpod.
- Updated documentation to reflect the new file naming convention.
- Modified example files to include part declarations for .firebase.dart files.
- Bumped version to 2.0.0 in pubspec.yaml and updated CHANGELOG to indicate breaking changes.
Fixes #<issue_number_goes_here>
It's a good idea to open an issue first for discussion.
- [ ] Tests pass
- [ ] Appropriate changes to README are included in PR
Summary of Changes
Hello @dorklein, I'm Gemini Code Assist[^1]! 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 introduces a significant update to improve compatibility with Riverpod by changing the naming convention for generated files from .g.dart to .firebase.dart. This change, along with numerous dependency updates to align with newer Dart SDK versions and package releases, constitutes a breaking change. The documentation and examples have been thoroughly revised to reflect these updates and showcase the enhanced integration capabilities, particularly with Riverpod.
Highlights
- Generated File Naming Convention: The postfix for generated files has been changed from
.g.dartto.firebase.dartto improve compatibility with Riverpod, which also uses.g.dartfor its generated files. This is a breaking change requiring updates topartdeclarations. - Dependency Updates: The project dependencies have been significantly updated, including bumping the minimum SDK version to
>=3.8.0,cloud_firestoreto^6.0.0,firebase_coreto^4.0.0,freezed_annotationto^3.1.0,json_annotationto^4.9.0,build_runnerto^2.8.0,freezedto^3.2.0, andjson_serializableto^6.11.0. - Documentation and Example Updates: The
README.mdanddocs/code-generation.mdfiles have been updated to reflect the new file naming convention and include new compatibility and development sections. Example files have been modified to correctly use the new.firebase.dartpart declarations. - Riverpod Integration: New integration tests and examples have been added to demonstrate compatibility and usage with Riverpod, including specific configurations in
build.yamlto ensure proper builder execution order. - Version Bump: The package version has been incremented to
2.0.0, signifying a major release with breaking changes, primarily due to the generated file naming convention change.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| 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 pull request 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 :thumbsup: and :thumbsdown: 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.
[^1]: 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.