feat: integrate `cupid` in cli using the `relation` command

[arjungarg07]

Description

This PR integrates @asyncapi/cupid in cli using the relation command.

Command usage syntax: asyncapi relation <context-1/filepath1> <context-2/filepath2> <context-3/filepath3> ...

It has one flag: --type which determines the output syntax of the relations and if not provided, would output default output syntax.

Related issue(s) #47

[fmvilas]

Great stuff, @arjungarg07! My only concern is that the command is not a verb. We decided to follow the form asyncapi VERB [NOUN] and relation is not a verb. What about visualize?

asyncapi visualize context1/asyncapi1 context2/asyncapi2 ...

[arjungarg07]

Yeah @fmvilas , I thought of using the verb visualize but I was skeptical about it since we are not actually visualizing the architecture right away but just getting the relations in desired output format and later pasting it in live editor to visualize.

[fmvilas]

🤔 I see what you mean. Maybe it should be something like asyncapi generate diagram? It kinda collapses with asyncapi generate where we probably want to use Generator. But maybe we can use asyncapi generate code and asyncapi generate docs for those...

For sure it can't be relation as it's not a verb/command, just a noun. Any other ideas?

[arjungarg07]

What about asyncapi generate relations ?

[fmvilas]

🤔 It might sound as you're generating the relations but the relations are already there, you're just "finding" them and generating a diagram, isn't it?

[arjungarg07]

I didn't think in that way, in that case asyncapi generate diagram would be good.

[fmvilas]

Yeah, now what worries me is that clash with asyncapi generate command. There's a related conversation going on in #129.

[sonarqubecloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[felixjung]

What about asyncapi relate?

relate

to find or show the connection between two or more things

[arjungarg07]

What about asyncapi relate?

Yeah, this could be done. @derberg what do you think about it?

[derberg]

@arjungarg07 not sure if this is intuitive. Look at https://github.com/asyncapi/cli/issues/129#issuecomment-998752834. I think it should go under generate because in the end you are generating something. It is about the outcome and not what the library is doing. You tell CLI to generate a diagram, and not find relations. At least this is how I look at it 🤔

@fmvilas have a look as you were involved here

[fmvilas]

Yeah, I still think it's better if we stick to generate diagram or similar. Always look at it from the point of view of the user who doesn't know the underlying technology and instead they expect the command to represent what they want to achieve. The tool used for this is irrelevant for them.

[sonarqubecloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

No Coverage information
0.0% Duplication

[derberg]

@arjungarg07 hey is this one ready for review?

• can you remove 2 code smells?
• can you remove manual bump of the cli version from package.json and package-lock.json, as we do it by the bot, and it will constantly cause issues for you on a PR, conflicts you do not want to have

[github-actions[bot]]

This pull request has been automatically marked as stale because it has not had recent activity :sleeping:

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

There can be many reasons why some specific pull request 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 pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

[derberg]

@arjungarg07 hey, not sure if you noticed but asyncapi generate is now possible, so you can continue with this PR if you want

[arjungarg07]

@derberg what would be the final command look like? asyncapi generate relation ?

[derberg]

I think mostly suggested was diagram not relation

this could maybe also be integrated with EDAVisualizer @jonaslagoni ?

so one command, but underneath different tools would be used

[derberg]

@arjungarg07 yo, should we keep it open?

[arjungarg07]

@derberg I had some doubts, to be resolved(asked above in the thread). Maybe, would open a new PR.

[derberg]

up to you 😃

[derberg]

to be resolved(asked above in the thread)

oh wait, sorry, which doubts are not yet solved?

[derberg]

@arjungarg07 I'm guessing we should close it, right?

[chinma-yyy]

@arjungarg07 I'm guessing we should close it, right?

So does it mean that this issue is open to other contributors @derberg ??

[derberg]

yes, but since Arjun is the maintainer of cupid, let's first confirm if this issue makes sense.

@arjungarg07 what are your plans with cupid, do you plan to continue maintain it?

[derberg]

closing for now, I'm in touch with @arjungarg07 to start a process of looking for new maintainers for cupid