Add keep_enum_prefix plugin option #187
Merged
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
This option, if specified, will instruct the plugin to NOT drop a common shared enum name prefix. By default, the prefix is removed as it used to be.
|
Oleg, I just saw your PR, will have a look soon. |
timostamm
reviewed
Nov 26, 2021
Go doesn't have an I am not a fan of this option, but see that it can be useful for migration. |
Co-authored-by: Timo Stamm <[email protected]>
Co-authored-by: Timo Stamm <[email protected]>
|
@timostamm thanks for reviewing, I've accepted your suggestions! I also don't like meaningless prefixes, but these days I care more about safe migrations than aesthetics 😄 (wasn't always the case in my career, heh) |
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.
This new option, if specified, will instruct the plugin to NOT drop a common shared enum name prefix. By default, the prefix
is removed.
Motivation: my company has a huge legacy TypeScript codebase that uses protobuf.js-generated proto definitions. We want to migrate it to protobuf-ts. Some enums are very pervasive, converted from and to strings with prefix assumed, so it's easier to just keep the damn prefix where it is.
We also have a ton of Go code where prefix is not removed, so for the sake of consistency I want to introduce this new option which is, of course, off by default.