Preserve trailing commas enum with members #1750
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rved (#1703) This PR changes the formatter to have it maintain trailing commas of last enum constants when there are members. So: ```dart enum E { a, b, c,; int x; } ``` Becomes: ```dart enum E { a, b, c, ; int x; } ``` Instead of: ```dart enum E { a, b, c; int x; } ``` Fixes #1678 Fixes #1729 Additionally, a similar style choice was presented in #1660 (comment) **Affected users**: - Those passing the `trailing_commas: preserve` config option and adding a trailing comma to their enum cases. - Users who don't already pass a trailing comma, aren't affected. So this PR shouldn't have undesirable effects on existing users. **Benefits**: - Maintains developer's intent - Less churn when adding additional member cases (Personally, I always add a trailing semicolon to avoid churn and to also make it even clearer this is an advanced enum with members.) **Downsides**: - 7 additional logical lines of code to maintain **Additional considerations**: I also considered implementing this for `enum E { a, b,; }`, however, that would require more drastic changes to the formatter as far as I can tell. Additionally, in this case the trailing semicolon provides fewer benefits: - churn when adding new members is the same if there was a trailing semicolon or not - giving the enum other members also only amounts to new lines being added rather than changed so again, no real churn. **Notes** - One test was changed due to this being a change in behavior. - This was surprisingly easy and enjoyable to implement (compliment to the existing code base). - I didn't make any changes to the `CHANGELOG.md` since this trailing commas preservation hasn't shipped yet so its behaviour is still undefined.
…#1749) Also add the style change to the CHANGELOG.
natebosch
approved these changes
Jul 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the same change you just reviewed + @jellynoone's original PR. Now I'm merging it into main.