typescript-angular: Feature/model suffix #418
Conversation
…uffixes of generated class and file names
…viceSuffix and serviceFileSuffix parameters
tomvangreen
changed the title
TiFu
left a comment
TiFu
left a comment
There was a problem hiding this comment.
How does this handle invalid suffixes? Do we want to ignore this case? (e.g. modelSuffix could make the model class name invalid by using invalid characters)
Looks good otherwise.
|
Yes, you are right. You could set the suffix to something invalid. I think this could also be a problem with the filename. From what I see we have following options:
I would say because of the filename probably approach 1 or 2 should be used. Better to catch this problem than to let it fail uncontrolled. Do you know of any similar cases in this project and how it is handled there? |
|
I added validation for class and file suffixes. As my earlier change with the service suffix has the same problem, I also added the validation for those configurations. Currently I only allow alpha numeric characters for class suffixes. For file suffixes I additionally allow the characters '.' and '-'. If any of the four config values is invalid I throw an IllegalArgument exception and display a message. |
macjohnny
left a comment
macjohnny
left a comment
There was a problem hiding this comment.
apart from some small documentation improvements this looks good.
| return name.substring(0, name.length() - modelSuffix.length()); | ||
| } | ||
|
|
||
| private void validateFileSuffixArgument(String argument, String value) { |
There was a problem hiding this comment.
please add a method description. describe what argument and value are or rename them to better understand their meaning
| } | ||
| } | ||
|
|
||
| private void validateClassSuffixArgument(String argument, String value) { |
|
Agreed. Thanks for the PR! |
|
@wing328 could you please add this to the |
4 participants
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.master,3.1.x,4.0.x. Default:master.Description of the PR
I introduced a
modelSuffixandmodelFileSuffixparameter in order to add suffixes to the generated models and model file names. Taking the samples from the sample, with this setting you could for example change the modelPetin the filepet.tstoPetVmin the filepet.vm.tsby defining the model suffixVmand the model file suffix.vm.The motivation behind this change is to have a clear distincation between generated models and models that are created by a developer. Having the ability to add a suffix to the generated models makes it immediatly obvious of what kind a model is.
I currently see one issue and that is that the class suffix gets also appended to enumeration types. The
StatusEnumin thePetclass will becomeStatusVmEnumif I set themodelSuffixoption toVm. I will have a look if I find how I can avoid that.@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny