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 TypeScript version configurable and default to v5 #20064

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dennisameling
Copy link
Contributor

TypeScript 5 was released in March of 2023, and has been adopted by many projects by now. The typescript client generator still defaults to v4, and will probably run into problems at some point.

Let's make the TypeScript version configurable, and default to v5 in all samples.

Not sure if the bump to v5 would be considered a breaking change. If it is, happy to keep the default at v4 for now. However, I assume most folks will be maintaining their own package.json with other versions in real projects.

Tagging the technical committee: @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) @joscha (2024/10)

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.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.

@joscha
Copy link
Contributor

joscha commented Nov 8, 2024

Generally looks LGTM, but I am wondering if we should just mandate TS 5.x starting with 7.10.0 - otherwise we'll drag TS v4 with us forever. TS 4.9.5 (https://github.com/microsoft/TypeScript/releases/tag/v4.9.5) was released end of Jan 2023, which makes it almost 2 years. I think that's acceptable to drop, @macjohnny WDYT?

@macjohnny
Copy link
Member

@dennisameling thanks for the contribution!

@joscha i agree we could probably go with v5, but for breaking changes we should still have a fallback until the next major version, and since currently there are no big differences in the code, i would just accept the PR as it is and when working towards the next release of openapigenerator, drop support for v4. agree?

@joscha
Copy link
Contributor

joscha commented Nov 8, 2024

@joscha i agree we could probably go with v5, but for breaking changes we should still have a fallback until the next major version, and since currently there are no big differences in the code, i would just accept the PR as it is and when working towards the next release of openapigenerator, drop support for v4. agree?

yeah that is fine. Just to note though:

npm exec [email protected] --yes -- tsc --noEmit

typechecks have been running with 5.6.3 already 🙈 . Not sure if we need to pick up the version of the respective generated package we want to check, if we really target 4.x compatiblity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants