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] Add importFileExtension option to support ECMAScript module resolution #14371

Merged
merged 4 commits into from
Jan 3, 2023

Conversation

danmichaelo
Copy link
Contributor

@danmichaelo danmichaelo commented Jan 3, 2023

Node.js ECMAScript module resolution requires file extensions for relative imports. Typescript also conforms to this requirement when using the new nodenext module resolution setting.

File extension support was already added to the Typescript(experimental) generator for Deno in #6732. The current PR generalizes the extensionForDeno parameter into importFileExtension and makes it user configurable, so users can set it to .js for a pure ESM package or .mjs for a dual package.

The current PR only adds the option to TypeScriptClientCodegen, which seems to be the new generator if I understand it right, but if the PR is accepted, I'd like to try adding it to AbstractTypeScriptClientCodegen as well in a separate PR, to support typescript-fetch and friends.

fixes #14333

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.
  • 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.

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka

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.

Thanks for your contribution

@macjohnny macjohnny merged commit 3dd313d into OpenAPITools:master Jan 3, 2023
@macjohnny macjohnny added this to the 6.3.0 milestone Jan 3, 2023
@julientechdev
Copy link

Thank you for this PR, adding support for typescript-fetch would be nice 👍

@florianbepunkt
Copy link

Support for the typescript axios generator would be nice as well.

@coeing
Copy link

coeing commented May 10, 2023

@danmichaelo Would it be possible to move the importFileExtension property to AbstractTypeScriptClientCodegen? This would make it available in other typescript code generators, like typescript-fetch and typescript-axios as well.

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.

[REQ] New typescript-generator option to set file extension for ECMAScript module resolution
5 participants