feat: oneof=unions-value to use the same field name for oneof cases #1062
Conversation
This file contains 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
stephenh
approved these changes
Jun 15, 2024
| @@ -752,7 +752,7 @@ ts-protoc --ts_proto_out=./output -I=./protos ./protoc/*.proto | |||
| # Todo | |||
|
|
|||
| - Support the string-based encoding of duration in `fromJSON`/`toJSON` | |||
| - Make `oneof=unions` the default behavior in 2.0 | |||
| - Make `oneof=unions-value` the default behavior in 2.0 | |||
There was a problem hiding this comment.
Ah nice! I definitely agree this value field is better and should be the default.
We're in luck that a 2.x release is likely going to happen in the next ~month or so, via #1058, so we should plan on flipping this default over, and honestly probably just removing the option/old behavior all together.
There was a problem hiding this comment.
Sounds great, feel free to ping me if you want help with that.
There was a problem hiding this comment.
Great! I'll ping you once Timo's PR lands as an 2.0.0 alpha and would be great to get this flipped over.
|
This is great, thank you @bhollis ! |
|
🎉 This PR is included in version 1.180.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1060.
This adds a new
oneof=unions-valueoption that changes how union oneof code is generated. Instead of each case having a field named the same as the$case, each of them has the same field, calledvalue. This should simplify writing generic code that can handle multiple cases at once.I chose to make it another option for
oneof=instead of a separate option since it's just another way of handling oneofs. I also updated the README but it may be a bit much, I'm happy to remove some stuff. I also presumptively suggest that this be the new recommended oneof option.