Skip to content

[TypeScript] All Clients Conform to same packaging scheme #4766

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

Conversation

kenisteward
Copy link
Contributor

@kenisteward kenisteward commented Feb 10, 2017

PR checklist

  • Read the contribution guildelines.
  • Ran the shell/batch script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates)
  • Filed the PR against the correct branch: master for non-breaking changes and 2.3.0 branch for breaking (non-backward compatible) changes.

Description of the PR

This updates all Typescript client generation to conform to one scheme. Now The AbstractTypescriptClient handles setting up package info supporting files.

This is related to issue #2694

Note: Not supplying npmName for any Typescript client no longer generates a default package.json with default name. If the npmName is not present, no package information is generated. This allows you just plop the client into an existing project. If npmName is provided, it will generate the package information so that you can have the opportunity to publish your generated client publicly or privately with no hassle.

@kenisteward
Copy link
Contributor Author

I'm not exactly sure how to fix this. @wing328 let me know what I did wrong :x

@wing328
Copy link
Contributor

wing328 commented Feb 10, 2017

@kenisteward thanks for the PR. samples/client/petstore/typescript-angular/pom.xml has been removed. Please add it back so that CIs can test the updated TS Pestore clients.

Also your commits (as shown in the Commits tab) are not linked to your Github account, which means this PR won't count as your contribution in https://github.com/swagger-api/swagger-codegen/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/swagger-api/swagger-codegen/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@kenisteward
Copy link
Contributor Author

@wing328 Is it possible to update the CI? I think it may be looking in the root folder but now it should be looking in the npm folder as I've updated it to be in line with the other package generators

@kenisteward
Copy link
Contributor Author

@wing328 I've found the error and i'm going to push the correction now. it was in the base pom.xml that I didn't update yet how verify -Psamples runs correctly locally

@wing328
Copy link
Contributor

wing328 commented Feb 13, 2017

@kenisteward is it correct to say that this is a breaking change? If yes, please file against 2.3.0 branch instead.

@kenisteward kenisteward mentioned this pull request Feb 15, 2017
3 tasks
@kenisteward
Copy link
Contributor Author

@wing328 This is only a breaking change for people who don't add npmName but expect to get packaging information. Would you say that requires to be put as a breaking change in 2.3.0? Technically all those clients would have to do is give a name and it wouldn't be a problem after.

@wing328 wing328 modified the milestones: v2.2.2, v2.2.3 Feb 22, 2017
@kenisteward
Copy link
Contributor Author

@wing328 should I resubmit this for 2.2.3 or 2.3.0?

@kenisteward
Copy link
Contributor Author

kenisteward commented Mar 2, 2017

@wing328 let me know if I need to resubmit this on a different branch or if it can stay here and still be merged on 2.2.3.

@wing328
Copy link
Contributor

wing328 commented May 17, 2017

@kenisteward sorry for late reply on this. I think it's fine to do it against the current master.

I wonder if you can rebase on the latest master to resolve the merge conflicts. Then I'll merge the enhancement into master.

@kenisteward
Copy link
Contributor Author

@wing328 I will look to see if it will actually work but I'm assuming it won't this was the first in my efforts to make all of the languages conform to 1 typescript definition. I'll try as soon as I can though.

Otherwise I had planned on working on #5104 which has a lot to do with this as well.

@wing328
Copy link
Contributor

wing328 commented May 18, 2017

For #5104, I'll send you an email to discuss in more details.

@wing328 wing328 modified the milestones: v2.2.3, v2.3.0 Jul 16, 2017
@wing328 wing328 modified the milestones: v2.3.0, v2.4.0 Dec 18, 2017
@wing328 wing328 closed this Jan 26, 2018
@kenisteward
Copy link
Contributor Author

kenisteward commented Jan 26, 2018 via email

@wing328
Copy link
Contributor

wing328 commented Jan 26, 2018

Opened #7502 to continue the discussion.

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.

2 participants