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

Integrate cupid in the CLI #47

Closed
Tracked by #251
arjungarg07 opened this issue Aug 12, 2021 · 22 comments
Closed
Tracked by #251

Integrate cupid in the CLI #47

arjungarg07 opened this issue Aug 12, 2021 · 22 comments
Labels
enhancement New feature or request

Comments

@arjungarg07
Copy link

arjungarg07 commented Aug 12, 2021

We are going to integrate app-relations-discovery functionalities into asyncapi cli which would allow users to access all the features of the library and get more work done from the terminal.

@arjungarg07 arjungarg07 added the enhancement New feature or request label Aug 12, 2021
@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.

@derberg
Copy link
Member

derberg commented Aug 12, 2021

@arjungarg07 you definitely need to provide a description mate 😆

I know you mean asyncapi relations but others need to know more and also the capabilities we need to take into account

@arjungarg07
Copy link
Author

arjungarg07 commented Aug 16, 2021

@derberg My proposition for commands usage:

asyncapi relations --files {FILES_PATH} --plantUml  // For plantUML classDiagram syntax
asyncapi relations --files {FILES_PATH} --mermaid  // For mermaid flowchart syntax
asyncapi relations --files {FILES_PATH} --reactFlow  // For reactFlow nodes syntax

Users will provide the no. of file paths for which she wants to get the relations of in {FILES_PATH}

@derberg
Copy link
Member

derberg commented Aug 17, 2021

I think we can start with relations as we can refactor name easily. you might want to share your thoughts here #37 . Just keep in mind we need to support --files and --contexts too. As for the types of outputs we need --type imho, so you have asyncapi relations --files {FILES_PATH} --type plantUML, and when you do asyncapi relations --files {FILES_PATH} you get default

Thoughts?

@arjungarg07
Copy link
Author

Just keep in mind we need to support --files and --contexts too.

What role will the --contexts play here, I think relations command would be standalone and would not be affected by contexts 🤔

As for the types of outputs we need --type imho, so you have asyncapi relations --files {FILES_PATH} --type plantUML, and when you do asyncapi relations --files {FILES_PATH} you get default

Yeah, we can move forward with this 👍🏽

@derberg
Copy link
Member

derberg commented Aug 17, 2021

context is like a file reference, so you do not need to remember the file path

so you can create a number of contexts, called file1, file2, file3 so you can do asyncapi validate --context file1, so you should also be able to do asyncapi relations --contexts file1, file2, file3

imagine you are working on this project https://github.com/amadeus4dev/amadeus-async-flight-status. You work with it every day, you have 2 different AsyncAPI files there, would you like to pass filepath every single time?

@arjungarg07
Copy link
Author

Got it! Super cool, so we have to support --files and --contexts too.

@arjungarg07 arjungarg07 changed the title feat: Integrate app-relations-discovery in the CLI Integrate app-relations-discovery in the CLI Aug 17, 2021
@derberg
Copy link
Member

derberg commented Aug 23, 2021

would be cool that once we render in terminal the marmaid and plantuml outputs, we also render a clickable URL, so user can open it up in respective editors. That would be nifty. Also explore available Ink components, maybe there is one already that can nicely display code snippets, would be useful for the output.

@Souvikns
Copy link
Member

This is something we can check for code snippets - https://github.com/vsashyn/ink-syntax-highlight
This is for clickable URL - https://github.com/sindresorhus/ink-link

@arjungarg07
Copy link
Author

Since the migration to Oclif is completed, I have started working on this.

@Souvikns
Copy link
Member

Yeah sure go ahead, let me know if you need any help.

@arjungarg07 arjungarg07 changed the title Integrate app-relations-discovery in the CLI Integrate `cupid in the CLI Nov 22, 2021
@arjungarg07 arjungarg07 changed the title Integrate `cupid in the CLI Integrate cupid in the CLI Nov 22, 2021
@magicmatatjahu
Copy link
Member

Solution that we should consider for that issue asyncapi/community#249 It's only an idea so please treat it as suggestion, not final approach. Feel free to comment :)

@Souvikns Souvikns mentioned this issue Mar 3, 2022
16 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2022

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 Jun 2, 2022
@derberg
Copy link
Member

derberg commented Jun 7, 2022

it is still active, PR is pretty advanced, you can do it @arjungarg07 💪🏼

@arjungarg07
Copy link
Author

@derberg am waiting for the structure of generate command to be implemented and finalized by #221

@github-actions github-actions bot removed the stale label Jun 8, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Oct 6, 2022

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 Oct 6, 2022
@derberg
Copy link
Member

derberg commented Oct 11, 2022

@arjungarg07 generate fromTemplate is there, so you can add cupid now 😉

@github-actions github-actions bot removed the stale label Oct 12, 2022
@arjungarg07
Copy link
Author

Sure, would be integrating it soon.

@github-actions
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 Feb 24, 2023
@derberg
Copy link
Member

derberg commented Apr 3, 2023

wip #143

@github-actions github-actions bot removed the stale label Apr 4, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

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 Aug 2, 2023
@derberg derberg removed the stale label Oct 25, 2023
@derberg
Copy link
Member

derberg commented Oct 25, 2023

closing as there is no activity for very long

@derberg derberg closed this as completed Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants