-
-
Notifications
You must be signed in to change notification settings - Fork 147
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: on asyncapi new
give users the ability to select an example as a starting point
#131
feat: on asyncapi new
give users the ability to select an example as a starting point
#131
Conversation
asyncapi new
give users the ability to select an example as a starting point
Hey @derberg any thoughts on this pull model for the examples? |
Just copying over convo from slack: https://asyncapi.slack.com/archives/CQVJXFNQL/p1636358757198500?thread_ts=1636124132.191400&cid=CQVJXFNQL |
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.
Only one suggestion :)
Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
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.
Should we add the asset folder to the files object in the package.json
Thanks @Souvikns! Forgot about that, all done 🙇 |
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
ff43a59
2ec385a
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.
LGTM! 🚀
Kudos, SonarCloud Quality Gate passed!
|
🎉 This PR is included in version 0.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Feature
asyncapi new
at the moment creates a new asyncapi file only using thesimple.yaml
example.This feature allows users to use an example (from here https://github.com/asyncapi/spec/tree/master/examples) as a starting point (which is an extra optional question).
Why
Just gives people more options and ways to start with AsyncAPI vs getting started with the default file.
For example if the user is interested in WebSockets they could select our web sockets example as a starting point.
How it works
If you want to watch 📹 it in action: https://asyncapi.slack.com/files/U020GN9C6FM/F02L5152LTG/cli-with-examples.mp4
Notes
The whole feature is optional, the user can still continue without picking any examples, and if no examples have been fetched the CLI will continue to work and user will be not be asked the question.