⚡️ Stop writing `// dart format width=80` to the generated freezed files

[AlexV525]

The builder of freezed does not specify the formatOutput, which will produce the default width=80 header in generated files. https://github.com/rrousselGit/freezed/pull/1160 removes the handling, so the default implementation is being used. The PR prevents it from being generated.

See also:

Where it got inserted:

• https://github.com/dart-lang/source_gen/blob/2a6be7efb194c37f74a66d22e1083f64ca187cb9/source_gen/lib/src/builder.dart#L417
• https://github.com/dart-lang/source_gen/blob/2a6be7efb194c37f74a66d22e1083f64ca187cb9/source_gen/lib/src/builder.dart#L436

How json_serializable handles it:

• https://github.com/google/json_serializable.dart/blob/d30c2fdb0598d548c25705931531842957623fdd/json_serializable/lib/src/json_part_builder.dart#L37
• https://github.com/google/json_serializable.dart/blob/d30c2fdb0598d548c25705931531842957623fdd/json_serializable/lib/src/json_part_builder.dart#L113

Summary by CodeRabbit

• New Features

  • Integrated automatic Dart code formatting into the build process for generated files.

• Bug Fixes

  • Ensured generated files no longer include the unnecessary // dart format width=80 comment.

• Tests

  • Added tests to verify proper header comments and absence of the old formatting comment in generated files.

• Documentation

  • Updated changelog to reflect these changes.

• Chores

  • Updated dependencies to include required formatting and versioning packages.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

A new Dart code formatting step was integrated into the Freezed code generation process, using the dart_style and pub_semver packages. The changelog and dependencies were updated accordingly. Additionally, a test was added to ensure generated files have the correct headers and do not include the old formatting comment.

Changes

File(s)	Change Summary
packages/freezed/CHANGELOG.md	Added unreleased patch note about removing // dart format width=80 from generated files.
packages/freezed/lib/builder.dart	Integrated Dart code formatting using DartFormatter, added formatOutput parameter, and updated imports.
packages/freezed/pubspec.yaml	Added dart_style and pub_semver as dependencies.
packages/freezed/test/source_gen_test.dart	Added test to verify generated files' headers and absence of the old format comment; updated imports.

Sequence Diagram(s)

sequenceDiagram
    participant Builder
    participant DartFormatter
    participant FileSystem

    Builder->>DartFormatter: Format generated Dart code
    DartFormatter-->>Builder: Return formatted code
    Builder->>FileSystem: Write formatted code to .freezed.dart file

Possibly related PRs

• rrousselGit/freezed#1145: Modified packages/freezed/lib/builder.dart to enhance Dart code formatting and adjust formatOutput logic, closely related to this PR’s changes.

Poem

In fields of code, the Freezed winds blow,
Now formatted neat, with a tidy flow.
Old comments gone, new headers in place,
Each file wears a freshly pressed face.
With tests to check and dependencies new—
This bunny hops forward, proud of the view!
🐇✨

---

📜 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 401ceda4f0b75d698740e2f2c099c3f9030937a2 and d5a8538e42acb3c347290cee78654c2d2609ec02.

📒 Files selected for processing (2)

• packages/freezed/CHANGELOG.md (1 hunks)
• packages/freezed/pubspec.yaml (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

Some tests are necesary here :)

[AlexV525]

@rrousselGit PTAL

[AlexV525]

@rrousselGit Would you take another look?

[rrousselGit]

LGTM