Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !3469

Support importMapping definitions for TypeScriptNodeClientCodegen

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/scottydawg/typescript-import-mappings into master Jul 25, 2019
  • Overview 0
  • Commits 2
  • Pipelines 0
  • Changes 5

Created by: scottydawg

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

This addresses an issue similar to Issue #3149 (closed) but for the TypeScript Node generator. This is a more general issue that could be implemented for all TypeScript generators, but I'm keeping the scope small initially.

The importMapping behavior described here and here in the usage docs, and supported by the Maven plugin configuration does not currently work for TypeScript generation.

This change allows a user to define these mappings and produce valid TypeScript import statements when using the TypeScriptNodeClientCodegen.

Note: Running the shell script ./bin/openapi3/typescript-node-petstore-all.sh in the master branch generates sample files that are different from the files currently in the repo. Running that script against this branch (typescript-import-mappings) produces the same differences. I have not included them here to avoid conflating unrelated changes.

cc:

  • @TiFu
  • @taxpon
  • @sebastianhaas
  • @kenisteward
  • @Vrolijkx
  • @macjohnny
  • @nicokoenig
  • @topce
  • @akehir
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/scottydawg/typescript-import-mappings