fix: freezed_missing_mixin on private types due to leading underscore #1279

refi64 · 2025-07-18T01:47:40Z

Private types get their leading underscore stripped off, but the lint wasn't accounting for that, so it would end up trying to change the type name to one that does not actually exist.

Summary by CodeRabbit

New Features
- Introduced an example showcasing a Freezed data class with improved mixin naming for private classes.
- Generated code now supports pattern matching and utility methods for the new example data class.
Bug Fixes
- Corrected the mixin naming logic for Freezed classes with private names, ensuring proper mixin application and code generation.

coderabbitai · 2025-07-18T01:47:46Z

Walkthrough

The changes update the mixin name construction logic in the Freezed lint package to handle private class names correctly. A new example demonstrates this behavior, including its generated code, showcasing proper mixin usage and pattern matching functionality for a Freezed data class.

Changes

Files	Change Summary
packages/freezed_lint/lib/src/missing_mixin.dart	Updated mixin name construction to handle private class names by removing leading underscores before prefixing.
packages/freezed_lint/example/lib/mixin_name.dart	Added an example Freezed data class `_FooModel` demonstrating correct mixin usage.
packages/freezed_lint/example/lib/mixin_name.freezed.dart	Added generated code for `_FooModel`, including mixin, copyWith, and pattern matching extensions.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Linter
    participant FreezedClass

    Developer->>Linter: Defines Freezed class (possibly private)
    Linter->>Linter: Constructs expected mixin name (removes leading _ if present)
    Linter->>FreezedClass: Checks for correct mixin inclusion
    FreezedClass-->>Linter: Provides mixin usage
    Linter-->>Developer: Reports missing or correct mixin usage

Estimated code review effort

2 (~15 minutes)

Suggested reviewers

rrousselGit

Poem

In the warren of code, a mixin was shy,
With an underscore cloak, it tried to slip by.
But the linting bunny, with keen, twitching nose,
Found the right name—no more double woes!
Now Freezed and its friends can hop with delight,
Thanks to the fix that made mixins just right! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7022540 and e5a7ba5.

📒 Files selected for processing (3)

packages/freezed_lint/example/lib/mixin_name.dart (1 hunks)
packages/freezed_lint/example/lib/mixin_name.freezed.dart (1 hunks)
packages/freezed_lint/lib/src/missing_mixin.dart (1 hunks)

🧠 Learnings (1)

📓 Common learnings

Learnt from: lishaduck
PR: rrousselGit/freezed#1147
File: packages/freezed_lint/pubspec.yaml:12-12
Timestamp: 2025-01-07T20:51:22.701Z
Learning: The analyzer version update to >=7.0.0 in freezed_lint package is blocked by invertase/dart_custom_lint#300, preventing alignment with freezed package's analyzer requirements.

Learnt from: lishaduck
PR: rrousselGit/freezed#1147
File: packages/freezed_lint/pubspec.yaml:12-12
Timestamp: 2025-01-07T20:51:22.701Z
Learning: The analyzer version upgrade in freezed_lint is blocked by invertase/dart_custom_lint#300 which handles the broader upgrade of analyzer, analyzer_plugin, and source_gen dependencies in custom_lint.

✅ Files skipped from review due to trivial changes (1)

packages/freezed_lint/example/lib/mixin_name.freezed.dart

🚧 Files skipped from review as they are similar to previous changes (1)

packages/freezed_lint/lib/src/missing_mixin.dart

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: lishaduck
PR: rrousselGit/freezed#1147
File: packages/freezed_lint/pubspec.yaml:12-12
Timestamp: 2025-01-07T20:51:22.701Z
Learning: The analyzer version update to >=7.0.0 in freezed_lint package is blocked by invertase/dart_custom_lint#300, preventing alignment with freezed package's analyzer requirements.

Learnt from: lishaduck
PR: rrousselGit/freezed#1147
File: packages/freezed_lint/pubspec.yaml:12-12
Timestamp: 2025-01-07T20:51:22.701Z
Learning: The analyzer version upgrade in freezed_lint is blocked by invertase/dart_custom_lint#300 which handles the broader upgrade of analyzer, analyzer_plugin, and source_gen dependencies in custom_lint.

🔇 Additional comments (2)

packages/freezed_lint/example/lib/mixin_name.dart (2)

1-3: LGTM! Standard Freezed setup.

The imports and part directive follow Freezed conventions correctly.

5-8: Perfect example demonstrating the private type fix.

This example correctly shows how private Freezed classes should work after the fix. The private class _FooModel properly uses the mixin _$FooModel, demonstrating that the linting now correctly handles the leading underscore stripping behavior.

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

rrousselGit · 2025-07-18T13:06:36Z

Make sure to add a test for this :)

refi64 · 2025-07-19T00:40:27Z

@rrousselGit oops I didn't realize there were tests because I had badly misread how they work, should be added now.

packages/freezed_lint/example/lib/missing_mixin.dart

Private types get their leading underscore stripped off, but the lint wasn't accounting for that, so it would end up trying to change the type name to one that does not actually exist.

refi64 force-pushed the missing-mixin-private branch from 7bbfefc to 7022540 Compare July 19, 2025 00:40

rrousselGit reviewed Jul 19, 2025

View reviewed changes

packages/freezed_lint/example/lib/missing_mixin.dart Outdated Show resolved Hide resolved

fix: freezed_missing_mixin on private types due to leading underscore

e5a7ba5

Private types get their leading underscore stripped off, but the lint wasn't accounting for that, so it would end up trying to change the type name to one that does not actually exist.

refi64 force-pushed the missing-mixin-private branch from 7022540 to e5a7ba5 Compare July 23, 2025 00:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: freezed_missing_mixin on private types due to leading underscore #1279

fix: freezed_missing_mixin on private types due to leading underscore #1279

refi64 commented Jul 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 18, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

rrousselGit commented Jul 18, 2025

Uh oh!

refi64 commented Jul 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

fix: freezed_missing_mixin on private types due to leading underscore #1279

Are you sure you want to change the base?

fix: freezed_missing_mixin on private types due to leading underscore #1279

Conversation

refi64 commented Jul 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

rrousselGit commented Jul 18, 2025

Uh oh!

refi64 commented Jul 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

refi64 commented Jul 18, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 18, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)