Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[typescript] Make TypeScriptClientCodegen extend AbstractTypeScriptClientCodegen #15096

Merged
merged 8 commits into from
Apr 9, 2023

Conversation

lwj5
Copy link
Contributor

@lwj5 lwj5 commented Mar 31, 2023

In #10080 (comment) from @wing328

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java also has this line of fix but TypeScriptClient codegen class doesn't extends AbstractTypeScriptClientCodegen.java at the moment.

In the future we may consider extending TypeScriptClient class with AbstractTypeScriptClientCodegen

This makes it easier to maintain

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    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.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@lwj5
Copy link
Contributor Author

lwj5 commented Mar 31, 2023

Would appreciate if any @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

could help to take a look at these

@lwj5 lwj5 marked this pull request as draft March 31, 2023 15:46
@macjohnny
Copy link
Member

IIRC the typescript client codegen was meant to be a rewrite for unification of all the typescript-variants there currently are, and intentionallly did not extend the abstract typescript codegen.
@TiFu to chime in

@lwj5
Copy link
Contributor Author

lwj5 commented Apr 3, 2023

@macjohnny it might seem so, but there are so many components that are reusable from AbstractTypeScriptClientCodegen that are exact duplicates.

By extending It, we remove over 500+ lines of duplicate code (see code changes) and also gain future bug fixes (since the abstract class is used by so many generators). I don't think it defeats the purpose of the unification but instead aids it, nonetheless, any of these methods can be overridden if needed.

Would be nice if we could get @TiFu update if he's going forward on this

@lwj5 lwj5 marked this pull request as ready for review April 3, 2023 06:41
Copy link
Contributor

@TiFu TiFu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally fine for me :)

Given the additional work that has gone into the AbstractTSClientCodegen, let's use it. The rewrite anyway re-used a lot of what AbstractTSClientCodegen was back then, so no harm in continuing to use it and reduce the maintenance effort.

@TiFu TiFu merged commit a5bc7f1 into OpenAPITools:master Apr 9, 2023
@lwj5 lwj5 deleted the ts-abstract branch April 10, 2023 09:21
@wing328 wing328 added this to the 6.6.0 milestone May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants