typescript-angular: Allow for custom naming of ApiModule #4209
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
mrmeku
force-pushed
the
prefix-typescript-angular
branch
from
5e881e8 to
fa19f7c
Compare
macjohnny
requested changes
Oct 22, 2019
bin/typescript-angular-v8-petstore-provided-in-root-with-prefixed-module-name.sh
Show resolved
Hide resolved
mrmeku
force-pushed
the
prefix-typescript-angular
branch
2 times, most recently
from
47f4dda to
9457bb9
Compare
In cases where a user wants to generate multiple module's, it is convenient to have these modules have different names.
mrmeku
force-pushed
the
prefix-typescript-angular
branch
from
9457bb9 to
a0b4105
Compare
macjohnny
approved these changes
Oct 24, 2019
|
@mrmeku thanks for the PR, which has been included in v4.2.0 release: https://twitter.com/oas_generator/status/1189824932345069569 |
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.
In cases where a user wants to generate multiple module's, it is convenient to have these modules have different names.
This change introduces a new additional property to the typescript-angular generator. The property is named
apiModulePrefixand will serve as the prefix for the generated ApiModule class. For example, ifapiModulePrefix=MyPrefixwere to be set, the generated module would be namedMyPrefixApiModule.The inspiration for this change is that in many projects I contribute to, we generate many ApiModules for different openapi services. Since all of these modules have the same name it forces to developers to use the
import { ApiModule as BlahModule } from ...syntax which is slightly annoying and is incompatible with some code inspection tools which expect that all classes have different names.The change is non breaking and tests have been added.
PR checklist
./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.1.x,5.0.x. Default:master.@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09) @topce (2018/10) @akehir (2019/07)
fixes #4101