Give enums valid names when specified with x-enum-varnames#10325
Open
UnsolvedCypher wants to merge 1 commit intoOpenAPITools:masterfrom
Open
Give enums valid names when specified with x-enum-varnames#10325UnsolvedCypher wants to merge 1 commit intoOpenAPITools:masterfrom
UnsolvedCypher wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
agilob
reviewed
Oct 5, 2021
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Show resolved
Hide resolved
Author
|
Hi @agilob , does this look ready to merge or do you have any concerns? |
Author
|
Hi @wing328 could you please take a look at this when you have a chance? It would be great to get it merged! |
Author
|
Hi @wing328, I believe this is good to merge. Please let me know if you would like any changes |
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
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 changes how x-enum-varnames behaves. Issue #3246 already describes the problem quite well, but to summarize, the current codegen just takes the value specified by x-enum-varnames and sets the enum variable name to it. This causes the generation of bad code when the specified name isn't a valid variable name, such as because it contains spaces. Additionally, different languages have different conventions for enum names, so for you may want
Partly cloudyto generatePARTLY_CLOUDYin Java butPartyCloudyin TypeScript.This change now passes the user-specified name to the language-specific
toEnumVarNamefunction for processing, so that the generated variable name is legal for the target language, and so that it conforms to language conventions or any other generator-specific settings that have been set. This is what issue #3246 refers to as "option 1" for a fix.If there is any other information I can provide, please let me know 😃
Fix #3246
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.For Windows users, please run the script in Git BASH.
master(5.3.0),6.0.x