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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Creating plugin system #1711

Open
2 tasks done
PriyamvadaShah opened this issue Mar 11, 2025 · 3 comments · May be fixed by #1712
Open
2 tasks done

[FEATURE] Creating plugin system #1711

PriyamvadaShah opened this issue Mar 11, 2025 · 3 comments · May be fixed by #1712
Labels
enhancement New feature or request

Comments

@PriyamvadaShah
Copy link
Contributor

Why do we need this improvement?

Create a plugin system so that when in order to incorporate some added functionality, the user can easily just describe it in their input file and describe the plugin in a file.
We can use hooks to make checks in CLI entry point

How will this change help?

Easy incorporation of some extended user needed functionality.

Screenshots

No response

How could it be implemented/designed?

Using plugin loader & registration functions

🚧 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?

None
@PriyamvadaShah PriyamvadaShah added the enhancement New feature or request label Mar 11, 2025
@github-project-automation github-project-automation bot moved this to To Triage in CLI - Kanban Mar 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@PriyamvadaShah PriyamvadaShah linked a pull request Mar 11, 2025 that will close this issue
Draft
@AayushSaini101
Copy link
Collaborator

@PriyamvadaShah Can you explain this better what you want to describe in this issue thanks

@PriyamvadaShah
Copy link
Contributor Author

PriyamvadaShah commented Mar 19, 2025 •
edited
Loading

@PriyamvadaShah Can you explain this better what you want to describe in this issue thanks

Sorry for the late reply, I was trying to research more on what hooks in current cli are present.
Actually, in asyncapi currently we don't have any plugins or hooks as such to extend our functionality to include any third party services or some validation that might be needed from our side, beyond what asyncapi's validate command offers.

The only hooks we currently have are generator hooks which work for generation only and are limited in functionality. We do use oclif hooks for things like'command-not-found' error but no plugin system of asyncapi is present.

So I was trying to create a plugin system with more hooks like cli:start, cli:exit, generate:before, generate:after and so on at different points in lifecycle. The system will detects hook files from the YAML (or JSON) file and lets users define hooks in that js file.

It would be great getting your feedback on this issue. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
CLI - Kanban
Status: To Triage
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: created a plugin system PriyamvadaShah/cli
2 participants
@AayushSaini101 @PriyamvadaShah