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-fetch: add option for TypeScript 3.6+ compatible generation #3801

Merged
merged 1 commit into from
Aug 30, 2019

Conversation

someone1
Copy link
Contributor

@someone1 someone1 commented Aug 29, 2019

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

The 3.6 release of typescript has some breaking changes that break the generated code. This PR updates the typescript-fetch generator to TypeScript 3.6 and replaces GlobalFetch with WindowOrWorkerGlobalScope.

I'd be happy to switch down to TypeScript 3.0 (I think this is the minimum version required for this change).

fixes #3798

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

@macjohnny
Copy link
Member

Maybe we could introduce an option to chose typescript3+? This way it would not be a breaking change

@someone1
Copy link
Contributor Author

@macjohnny : Any guidance on how I should add options to the client generator?

@someone1 someone1 force-pushed the fix-3798 branch 3 times, most recently from ce27aee to e776e78 Compare August 29, 2019 20:39
@someone1
Copy link
Contributor Author

@macjohnny I think it's ready for review - hopefully I did this all correctly!

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

@macjohnny macjohnny added this to the 4.1.2 milestone Aug 30, 2019
@macjohnny
Copy link
Member

@someone1 thanks for your PR!
The CI reports
ERROR: Failed to run ./bin/typescript-fetch-petstore-all.sh
Exited with code 1

Can you fix this?

@@ -0,0 +1,32 @@
#!/bin/sh
Copy link
Member

Choose a reason for hiding this comment

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

Please add a windows-version in /bin/windows, too

Copy link
Member

Choose a reason for hiding this comment

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

Maybe this script still needs to be made executable, i.e.

chmod u+x bin/typescript-fetch-petetore-typescript-three-plus.sh

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The command was git update-index --chmod=+x bin/typescript-fetch-petstore-typescript-three-plus.sh for me (using WSL/Windows so maybe that's what screwed this up)

@someone1
Copy link
Contributor Author

@macjohnny - ready for review again, added the windows batch file

@someone1 someone1 changed the title typescript-fetch: bump to typescript 3.6 and fix breaking changes typescript-fetch: add option for TypeScript 3.6+ compatible generation Aug 30, 2019
Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

@macjohnny
Copy link
Member

please remove the newline at the end of docs/generators/typescript-fetch.md

@someone1
Copy link
Contributor Author

@macjohnny - done

@macjohnny macjohnny merged commit 1b12b89 into OpenAPITools:master Aug 30, 2019
@wing328
Copy link
Member

wing328 commented Sep 12, 2019

@someone1 thanks for the PR, which has been included in the v4.1.2 release: https://twitter.com/oas_generator/status/1172068944355528705

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.

[BUG] [typescript-fetch] TypeScript 3.6 breaks generated code
3 participants