openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

Add typescript 5.x as an allowed version.

Open jyasskin opened this issue 1 year ago • 1 comments

We're using Typescript 5 in the project that uses the openapi-generator, but the generated package.json files claim only to support 4.x. This mostly doesn't cause practical problems, but it does seem to have confused Github's dependabot last week, although the ticket with GH's investigation isn't public. Since the generated typescript does seem compatible with both major versions, I've widened the version constraint in all the package.json files.

I wasn't sure which package-lock.json files to update, since that controls the version that's actually used in tests. I thought it was useful to test that typescript-5.x works at all, so I regenerated two in the typescript-fetch test and left the others alone. I'm happy to make a different choice if the maintainers prefer.

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] 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.
  • [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] 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)

jyasskin avatar May 14 '24 20:05 jyasskin

@jyasskin did you test all the typescript-* generators to work with typescript 5.0?

macjohnny avatar May 15 '24 09:05 macjohnny

@macjohnny Good point. I've undone the change to the 'typescript' generator, where it caused errors in the inversify build, and I pinned the @types/node version in typescript-axios to <=12.20.42 since that breaks with later versions in the 12.* series, with either version of typescript. I also pinned a few @types versions in some test directories that are using typescript v2. Then I ran:

(set -e;
find -name package-lock.json | xargs rm -f;
find -name node_modules | xargs rm -rf;
./bin/generate-samples.sh ./bin/configs/typescript*.yaml;
for f in $(find $(find $(find samples -name '*typescript*') -name 'builds') -name pom.xml | grep -v typescript-fetch/builds/prefix-parameter-interfaces); do echo $f; mvn integration-test -f  $f; done;
for f in $(find $(find $(find samples -name '*typescript*') -name 'tests') -name pom.xml | grep -v petstore/typescript/tests/jquery); do echo $f; mvn integration-test -f  $f; done;
)

All of these tests passed with this change.

Explanations of the exceptions in the above script:

  • typescript-fetch/builds/prefix-parameter-interfaces/pom.xml seems to be broken by trying to call npm test with no test script in the adjacent package.json.
  • typescript/tests/jquery uses typescript 2.4.1, and it fails with error:0308010C:digital envelope routines::unsupported in a clean client.

I also checked several of the resulting directories with npx tsc --version to make sure they were testing with typescript 5.

jyasskin avatar May 15 '24 18:05 jyasskin