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

Add optional erasable syntax configuration to Typescript generator. #21040

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

brendandburns
Copy link
Contributor

Typescript 5.8 added a new flag that optionally removes support for non-erasable syntax. This facilitates running Typescript directly in node 22 without transpiling. This PR adds a new configuration option to the Typescript generator to generate code that complies with erasable syntax only. It is off by default.

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.

@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)

@amakhrov
Copy link
Contributor

amakhrov commented Apr 5, 2025

Is there a reason not to ALWAYS generate erasable syntax, without extra configuration and complexity in the templates?

@brendandburns
Copy link
Contributor Author

@amakhrov

Personally, I'm ok with that, but I made it optional because I wanted to minimize the potential impact to users of this generator.

@joscha
Copy link
Contributor

joscha commented Apr 6, 2025

I think having both options is quite the onus on future implementers and maintainers. You always have to think about both cases and what's supported might change over time as well as ecmascriot evolves, etc.

Given that we want to run future versions of this on native node, I personally would go with one of two options:

  • Always produce erasable syntax
  • Flick the switch to default yes for now, so all test fixtures are produced with erasable syntax and then we add node into CI to ensure we're compatible. Given that erasable syntax is always compatible with non-erasable, that seems to be the safer bet overall. Then, in the near future, I don't know, 7.13 or something, we remove the old code path.

Thoughts?

@brendandburns
Copy link
Contributor Author

@joscha I'm fine with either option. I defer to the various typescript technical committee members opinion. Let me know the preferred solution and I will implement it in this PR.

@joscha
Copy link
Contributor

joscha commented Apr 7, 2025

@amakhrov @macjohnny thoughts?

@topce
Copy link
Contributor

topce commented Apr 7, 2025

@brendandburns I like what you done: to be optional and by default working like before
not sure all users target latest version of node...
LGTM as it is.

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