Skip to content
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

fix: made studio command consistent with other commands #1635

Closed
wants to merge 1 commit into from

Conversation

SahilDahekar
Copy link
Contributor

Description

  • Updated asyncapi start studio command to input spec file as a argument rather than from a -f flag.
  • Added instruction in console on how to open studio with own spec file . This instruction is only visible when no spec file arg is specified .
  • Updated docs to reflect the change in asyncapi start studio command usage.
  • Added a default asyncapi.yml file to open in case no spec file is passed as input argument.

Screenshots

  • Default spec file asyncapi.yml opens when not specified with start studio command with terminal instruction on how to open own spec file .

Screenshot from 2025-01-18 18-09-54

Output :

To open a specific AsyncAPI file in the Studio, use: asyncapi start studio [your-spec-file-location]

Studio is now running at http://localhost:3210?liveServer=3210&studio-version=0.20.2.
You can open this URL in your web browser, and if needed, press Ctrl + C to stop the process.
Watching changes on file asyncapi.yml

Screenshot from 2025-01-18 18-09-25

  • Instruction is not logged when using own spec file .

Screenshot from 2025-01-18 18-10-32

Output :

Studio is now running at http://localhost:3210?liveServer=3210&studio-version=0.20.2.
You can open this URL in your web browser, and if needed, press Ctrl + C to stop the process.
Watching changes on file /home/sahil/test.yaml

Related issue(s)

Resolves #1623

Copy link

changeset-bot bot commented Jan 18, 2025

⚠️ No Changeset found

Latest commit: eba1126

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@derberg
Copy link
Member

derberg commented Jan 20, 2025

/ptal

suggestion to maintainers to close this PR as it is duplicate of #1631 and actually author of #1631 is doing the right thing of having discussion in the issue on the scope

@asyncapi-bot
Copy link
Contributor

@Amzani @Souvikns @AayushSaini101 @Shurtu-gal Please take a look at this PR. Thanks! 👋

@SahilDahekar
Copy link
Contributor Author

/ptal

suggestion to maintainers to close this PR as it is duplicate of #1631 and actually author of #1631 is doing the right thing of having discussion in the issue on the scope

Didn't see the PR #1631 , closing this as duplicate . Sorry for inconvenience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

asyncapi start studio is not consistent with other commands
3 participants