Add migration guide #1189
Add migration guide #1189
Conversation
|
Warning Rate limit exceeded@rrousselGit has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 41 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
WalkthroughThe pull request updates documentation for the Freezed package. A new "Migration" section is added to the README to provide a link to the migration guide and changelog. Additionally, the migration guide now details the changes necessary for upgrading from version 2 to version 3, including new requirements for class signatures, removal of auto-generated pattern matching extensions, and guidance on using classic Dart classes. Changes
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
I just recognized that you can generate unions without making them sealed. @freezed
class Union with _$Union {
const factory Union.data(int value) = Data;
const factory Union.loading() = Loading;
const factory Union.error([String? message]) = Error;
}Is there any use case to this? |
There's no reason to require the |
|
@rrousselGit Thanks for clarification. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/freezed/migration_guide.md (2)
35-35: Nitpick: Correct Inline Code Spacing
There is an extra space inside the inline code spans in “.map/.when”. Removing the space to read “.map/.when” will help comply with markdownlint (MD038).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
35-35: Spaces inside code span elements
null(MD038, no-space-in-code)
94-96: Resolve the<TODO>in Advanced Topics
The<TODO>marker indicates that the Advanced Topics section is incomplete. Please add the appropriate content or remove the placeholder to finalize the migration guide.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/freezed/README.md(2 hunks)packages/freezed/migration_guide.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/freezed/README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
packages/freezed/migration_guide.md
35-35: Spaces inside code span elements
null
(MD038, no-space-in-code)
🔇 Additional comments (3)
packages/freezed/migration_guide.md (3)
10-22: Enforce Updated Class Signature forPerson
The change fromclass Person with _$Person {toabstract class Person with _$Person {satisfies the new requirement for factory classes. Ensure that all usages ofPersonnow consider its abstract status.
25-31: EnforcesealedModifier forModelClass
Changing the declaration tosealed class Model with _$Model {is consistent with the migration guide’s requirements. This update strengthens inheritance boundaries and clarifies intent.
37-48: Adopt Dart’s Built-in Pattern Matching
The updated switch expression using pattern matching is a clear improvement over the previous.mapapproach. Verify that your target Dart version supports this syntax fully.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/freezed/migration_guide.md (1)
38-49: Adopt Dart’s Built-In Pattern MatchingReplacing the auto-generated
.mapextension with the Dartswitchexpression modernizes the code and aligns with the migration guide’s intent. It might be beneficial to explicitly mention the required Dart SDK version (e.g., Dart 3.0 or later) that supports this syntax within the guide.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/freezed/migration_guide.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: freezed (packages/freezed_lint, master, get)
- GitHub Check: freezed (packages/freezed_annotation, master, get)
- GitHub Check: freezed (packages/freezed, master, get)
🔇 Additional comments (2)
packages/freezed/migration_guide.md (2)
10-22: UpdatePersonClass Declaration to AbstractChanging the declaration from
class Person with _$Persontoabstract class Person with _$Personcorrectly enforces that the class cannot be directly instantiated, which aligns with the new migration requirements. Please ensure that any user code referencingPersonis updated accordingly.
25-31: Enforce Sealed Hierarchy inModelClassUpdating the
Modelclass to use thesealedkeyword instead of a plain class declaration clearly restricts subtype extension to within the library. This change improves safety by ensuring the union is closed for extension and supports better exhaustiveness checking in pattern matching.
|
Classes can be concrete. I cannot require abstract/sealed. |
packages/freezed/README.md
Outdated
| @@ -1247,6 +1248,10 @@ targets: | |||
| when_or_null: false | |||
| ``` | |||
| # Migration | |||
There was a problem hiding this comment.
This should be at the top, not the bottom
packages/freezed/migration_guide.md
Outdated
| ``` | ||
|
|
||
|
|
||
| ### Classic classes (new) |
There was a problem hiding this comment.
I don't see how this is related to migration
closes #1187
Summary by CodeRabbit