feat: Always generate enums with sorted members#728
Merged
dbanty merged 4 commits intoopenapi-generators:mainfrom Mar 12, 2023
expobrain:ordered_enum_values
Merged
feat: Always generate enums with sorted members#728dbanty merged 4 commits intoopenapi-generators:mainfrom expobrain:ordered_enum_values
dbanty merged 4 commits intoopenapi-generators:mainfrom
expobrain:ordered_enum_values
Conversation
Collaborator
|
I don't think the order was random, it should have been the order in which they were declared, so it should be consistent between runs. However, this is better since even reordering the declaration in the schema shouldn't generate different code. I wonder if we should do this with properties of objects as well 🤔 |
Codecov Report
@@ Coverage Diff @@
## main #728 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 49 49
Lines 1971 1971
=========================================
Hits 1971 1971 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Collaborator
Author
|
Probably yes, but in another PR |
dbanty
previously approved these changes
Mar 12, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
The code generator always renders the enum members in alphabetical order so that to minimise the changes in the generated code.
Tl;RL
Previously the enum members were collected as a dictionary in a random order and rendered as is, this was causing multiple run of the code generator to render the enum members in different order. If the generated code is then committed in a VCS it would create unnecessary changes because of the different order of the semantically same enum definition.
With this change the enum members are always rendered in alphabetical order so enums that are semantically the same will be rendered also the same in the code.