feat: add support for comments on union fields in generateOneofProperty #1136
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
- Added functionality to `generateOneofProperty` to include comments for each union field, enhancing documentation support for union fields in TypeScript output. - Previously, comments for individual fields within a `oneof` type were omitted. This update gathers comments from each field and appends them to the generated type for clarity. Issue: [stephenh#1122](stephenh#1122)
stephenh
approved these changes
Nov 13, 2024
There was a problem hiding this comment.
@sefaphlvn this looks great! Can you run yarn proto2ts and push the changed files up to the PR? That is basically how we regression test changes.
|
Shoot, @sefaphlvn looks like we're really close to merging, but prettier failed; can you run |
|
Looks great! Thanks @sefaphlvn ! |
|
🎉 This issue has been resolved in version 2.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
stephenh
pushed a commit
that referenced
this pull request
Nov 25, 2024
This PR tweaks the output from #1136 slightly to avoid adding the trailing `//` after the union member separator if there isn't a documentation comment for the following oneof field (or if comments are turned off).
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.
generateOneofPropertyto include comments for each union field, enhancing documentation support for union fields in TypeScript output.oneoftype were omitted. This update gathers comments from each field and appends them to the generated type for clarity.Issue: #1122