-
-
Notifications
You must be signed in to change notification settings - Fork 197
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
feat: add JSDoc style comment support to Typescript generator #621
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small specific comment, also remember to add tests to ensure it works as intended 👍
It seems you might have auto-formatting enabled in your development environment making unnecessary changes that make it harder to review, do you mind disabling it and re-commit the intended changes? 🙂
Auto formatting removed |
@gabormagyar sorry I did not caught this the first time, this has to be added as a preset instead, similar to what is being done here: #649 and what we have for Java https://github.com/asyncapi/modelina/blob/master/docs/languages/Java.md#include-javadoc-for-properties already. We need to remember, that it's up to the users how the output model should sticked together 🙂 |
Pull Request Test Coverage Report for Build 1955916041
💛 - Coveralls |
@jonaslagoni Please re-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 👍
We are only missing an example and updating the documentation: https://github.com/asyncapi/modelina/blob/master/docs/languages/JavaScript.md
Otherwise there are no easy way for others to know about it 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gabormagyar Please add typscript-generate-comment
here. 😊
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked rest looks good to me 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
Got some linting problems 🙂 |
/rtm |
Kudos, SonarCloud Quality Gate passed!
|
/rtm |
🎉 This PR is included in version 0.52.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
@all-contributors please add @gabormagyar for code, test, docs, example |
I've put up a pull request to add @gabormagyar! 🎉 |
🎉 This PR is included in version 1.0.0-next.23 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Might need tests; tests for comment generation are already included just not for them being included. Don't think it needs docs as the feature is automatic and self explanatory.
Make sure to filter whitespace changes when viewing diff.