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

[FEATURE] New Command to format the Asyncapi document [ Mentorship Project Part 2 ] #1419

Closed
2 tasks done
AayushSaini101 opened this issue May 13, 2024 · 5 comments · Fixed by #1573
Closed
2 tasks done
Labels
enhancement New feature or request released

Comments

@AayushSaini101
Copy link
Contributor

Why do we need this improvement?

Introducing new command that helps to format the asyncapi document with the help of CLI that help to reduce the errors as well as increase the readability of the document.

How will this change help?

asyncapi format the command helps to format the document

Screenshots

No response

How could it be implemented/designed?

  • Parse the Asyncapi document
  • Return the document with the proper formatting

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@AayushSaini101 AayushSaini101 added the enhancement New feature or request label May 13, 2024
@github-project-automation github-project-automation bot moved this to Backlog in CLI - Kanban May 13, 2024
@Amzani
Copy link
Collaborator

Amzani commented May 13, 2024

Hi @AayushSaini101 could you provide some examples? Thanks

@AayushSaini101
Copy link
Contributor Author

Hi @AayushSaini101 could you provide some examples? Thanks

We have different formatter available that format the yml online: https://jsonformatter.org/yaml-formatter Here is one of its,

@Amzani one example
Before formatting:

image

After Formatting:
image

Copy link
Contributor

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Sep 11, 2024
@AayushSaini101 AayushSaini101 changed the title [FEATURE] New Command to format the Asyncapi document [FEATURE] New Command to format the Asyncapi document [ Mentorship Project Part 2 ] Nov 13, 2024
@AayushSaini101
Copy link
Contributor Author

Proposed Format of the command:
asyncapi format asyncapi.yml --output

@asyncapi-bot
Copy link
Contributor

🎉 This issue has been resolved in version 2.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
Archived in project
3 participants