feat: on asyncapi new give users the ability to select an example as a starting point#131
Merged
magicmatatjahu merged 15 commits intoasyncapi:masterfrom Nov 18, 2021
Conversation
boyney123
changed the title
asyncapi new give users the ability to select an example as a starting point
Contributor
Author
|
Hey @derberg any thoughts on this pull model for the examples? |
Contributor
Author
|
Just copying over convo from slack: https://asyncapi.slack.com/archives/CQVJXFNQL/p1636358757198500?thread_ts=1636124132.191400&cid=CQVJXFNQL
|
fmvilas
requested changes
Nov 8, 2021
fmvilas
requested changes
Nov 8, 2021
Member
magicmatatjahu
left a comment
magicmatatjahu
left a comment
There was a problem hiding this comment.
Only one suggestion :)
Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
magicmatatjahu
suggested changes
Nov 8, 2021
fmvilas
requested changes
Nov 8, 2021
Souvikns
reviewed
Nov 9, 2021
Member
Souvikns
left a comment
Souvikns
left a comment
There was a problem hiding this comment.
Should we add the asset folder to the files object in the package.json
Contributor
Author
Thanks @Souvikns! Forgot about that, all done 🙇 |
fmvilas
reviewed
Nov 9, 2021
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
magicmatatjahu
previously approved these changes
Nov 9, 2021
Souvikns
previously approved these changes
Nov 9, 2021
boyney123
dismissed stale reviews from Souvikns and magicmatatjahu
via
ff43a59
magicmatatjahu
previously approved these changes
Nov 10, 2021
fmvilas
previously approved these changes
Nov 10, 2021
boyney123
dismissed stale reviews from fmvilas and magicmatatjahu
via
2ec385a
|
Kudos, SonarCloud Quality Gate passed!
|
Contributor
|
🎉 This PR is included in version 0.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Feature
asyncapi newat the moment creates a new asyncapi file only using thesimple.yamlexample.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.