fix: help command #593

sambhavgupta0705 · 2023-05-25T08:27:06Z

Description

...
...
...

Related issue(s)

#559

Souvikns

I think you should create a new folder called hooks, instead of adding this in the errors folder

Souvikns · 2023-05-25T08:41:50Z

package.json

@@ -105,10 +104,13 @@
  "main": "lib/index.js",
  "oclif": {
    "commands": "./lib/commands",
+    "hooks": {
+      "command_not_found": [
+        "./lib/hooks/command_not_found/example"


Suggested change

"./lib/hooks/command_not_found/example"

"./lib/src/errors/command-not-found"

I think this should be the path of the hook, not really sure, looking at this example it looks like that

@Souvikns i've added the hook in hooks/command-not-found folder, it should work right ?

I think that should be a file path, check that after building the project does that path has any file

Yeah, it's just file paths that we have to link back in package.json. It's working build.

I just separated the hooks into folders based on events for further clarification if anyone wants to add new hooks.

kaushik-rishi · 2023-05-25T08:48:36Z

@Souvikns Just a quick question before i bail out, how are we supposed to prevent the
@oclif/plugin-not-found from triggering, inside the hook that we are working with ?

Souvikns · 2023-05-25T08:49:53Z

The plugin we are using right now is actually a hook, you can use that as an example https://github.com/oclif/plugin-not-found

kaushik-rishi · 2023-05-25T08:51:30Z

The plugin we are using right now is actually a hook, you can use that as an example https://github.com/oclif/plugin-not-found

But we would still need the oclif/plugin-not-found for any other user entered commands which donot exist right ?

We basically need this new hook on top of oclif/plugin-not-found as far as i get it. please correct me.

sambhavgupta0705 · 2023-05-25T08:53:16Z

This is the output @Souvikns

sambhavgupta0705 · 2023-05-25T08:54:13Z

The plugin we are using right now is actually a hook, you can use that as an example https://github.com/oclif/plugin-not-found

yes I read the blog and the hook was setup inside the plugin

Souvikns · 2023-05-25T08:55:11Z

I don't think we need the old plugin we are replacing it with our custom hook

kaushik-rishi · 2023-05-25T08:56:27Z

This is the output @Souvikns

cli/src/hooks/command_not_found/help-command-handler.ts

Line 4 in 479c31d

console.log(opts);

I just logged the options passed for reference. You can build on top of this.

sambhavgupta0705 · 2023-05-25T08:58:55Z

@kaushik-rishi I think we should not console.log this whole message and just console help command doesn't exist try --help

Souvikns · 2023-05-25T08:59:54Z

That output is comping from logging the opts right, now you just have to have a custom warning about it. I think if you see that log that means that the hook is connected to the CLI

kaushik-rishi · 2023-05-25T08:59:59Z

@sambhavgupta0705 yes, i just logged it for your reference.
i've written an if condition below it inside of which you can build.

kaushik-rishi · 2023-05-25T10:26:07Z

@sambhavgupta0705 please remove the errors folder. just reminding.

Signed-off-by: Sambhav Gupta <[email protected]>

sambhavgupta0705 · 2023-05-25T14:44:06Z

@sambhavgupta0705 please remove the errors folder. just reminding.

okay the one made by me

sambhavgupta0705 · 2023-05-25T14:57:07Z

@Souvikns the PR is ready for review

kaushik-rishi · 2023-05-25T15:00:34Z

package-lock.json shouldn't technically change.

As we didn't install or uninstall any package I think we can safely revert package-lock.json changes.

kaushik-rishi · 2023-05-25T15:15:45Z

I don't think we need the old plugin we are replacing it with our custom hook

@Souvikns need your suggestions 🙂

i understand, but what about the fallback for other commands, the hook developed here is handling just the help command and suggesting the user to use --help.
What if i use something like asyncapi generte (intentional typo), we would still need the plugin-not-found to give us a fallback option to suggestions from the plugin right ?

Also, @sambhavgupta0705 can we rather find a way to just bail out and exit after the console.log in the hook, not to forward the entire case to plugin-not-found module ?

sambhavgupta0705 · 2023-05-25T15:17:01Z

Yes we can add .exit functionality here.

kaushik-rishi · 2023-05-25T16:05:20Z

@sambhavgupta0705 for your reference.
follow the last line of this documentation https://oclif.io/docs/hooks.
you can use this.exit() to exit out instead of going further.

Try it once, you might see other issues. Just a hint forward. 🙂

let @Souvikns confirm if this is what we are looking forward to do.

kaushik-rishi · 2023-05-25T16:06:19Z

src/hooks/command_not_found/help-command-handler.ts

+  if (opts.id === 'help') {
+    console.log('help command doesn\'t exist try --help');
+  }
+};


this.exit() is what we would want here (incase we want to exit out)

Yes I will implement it

Will this work, I mean if the control ever goes to the plugin it will say to use asyncapi help command and that does not exist.

sambhavgupta0705 · 2023-05-25T18:29:57Z

@kaushik-rishi I tried adding this.exit() but the plugin console was always get printed

kaushik-rishi · 2023-05-25T18:44:58Z

@kaushik-rishi I tried adding this.exit() but the plugin console was always get printed

It is probably due to asynchronous nauigure, i'm afraid i don't have a solution for this right away.

I can explain the situation better.
May be it's like once the hook is triggered both the plugins (the one we wrote and the plugin-not-found) and being called at the same time. It is exiting fine but before exiting it's printing the first line of the plugin-not-founds prompt.

sambhavgupta0705 · 2023-05-25T18:51:35Z

Yess

kaushik-rishi · 2023-05-25T19:33:57Z

Yess

I have a couple of ideas, Let @Souvikns catch up and review the discussion uptill now. 🙂

We can easily make our own hook for handling every command that isn't found. Let's carry it further.

Souvikns · 2023-05-26T07:56:58Z

Yeah, the plugin used to suggest or at least try to suggest an alternative command if one is wrong, I think we can build this feature, you can take inspiration from the plugin if you want.

kaushik-rishi · 2023-05-26T08:00:09Z

Yeah, the plugin used to suggest or at least try to suggest an alternative command if one is wrong, I think we can build this feature, you can take inspiration from the plugin if you want.

@Souvikns
I'm not very aware of the licenes, but looking at this (licence), are we allowed to copy the code into our hook and then modify as per our requirements ?

kaushik-rishi · 2023-05-26T08:01:23Z

package-lock.json

@sambhavgupta0705
please revert the package-lock.json changes.

Souvikns · 2023-05-26T08:03:01Z

You write the code, and you can take inspiration from it, and write it in your own way, I don't know about the license, @derberg are we breaking any rules here?

kaushik-rishi · 2023-05-26T08:20:32Z

You write the code, and you can take inspiration from it, and write it in your own way, I don't know about the license, @derberg are we breaking any rules here?

If we have the ability to re-use the code, we can skip rewriting it 🙂 . Let @derberg clarify. We can write our own handler in the worst case, Won't be that difficult.

Souvikns · 2023-06-06T12:13:50Z

@sambhavgupta0705 @kaushik-rishi, @derberg is not available right now, you can go ahead and start building the suggestion feature, no need to reuse but if you want you can take inspiration from the existing library.

kaushik-rishi · 2023-06-06T12:14:32Z

Sure @Souvikns

sambhavgupta0705 · 2023-06-08T07:30:25Z

@sambhavgupta0705 @kaushik-rishi, @derberg is not available right now, you can go ahead and start building the suggestion feature, no need to reuse but if you want you can take inspiration from the existing library.

Yup just busy with some work,will start working on this by this week.

sambhavgupta0705 · 2023-06-10T05:10:30Z

hey @kaushik-rishi ,what other changes do we need to do?

sonarqubecloud · 2023-06-21T17:17:27Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
1.0% Duplication

kaushik-rishi · 2023-06-22T04:25:09Z

hey @kaushik-rishi ,what other changes do we need to do?

Hey @sambhavgupta0705
Was a bit busy since a couple of days.
We can take inspiration from the @oclif/not-found and recreate some workflow to let the user know that they've entered a command that is not yet registered.

derberg · 2023-06-27T13:13:39Z

oclif is done under MIT license, so it is definitely fine to copy some code. Just attribute original creators in the readme

Souvikns · 2023-07-19T08:34:09Z

@sambhavgupta0705 let us know if anything is blocking you or if you need any help.

sambhavgupta0705 · 2023-07-19T10:58:18Z

@Souvikns just got busy with mentorship program work .I will soon find a way to resolve this ASAP

Souvikns · 2023-09-25T09:13:54Z

@sambhavgupta0705 any updates on this?

sambhavgupta0705 · 2023-09-26T00:22:02Z

ohh sorry I totally forgot about this

Souvikns · 2023-11-29T10:02:37Z

@sambhavgupta0705 can you resolve the conflict

sonarqubecloud · 2023-12-15T08:00:11Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

4 New issues
0 Security Hotspots
No data about Coverage
1.0% Duplication on New Code

See analysis details on SonarCloud

peter-rr · 2024-03-21T12:50:07Z

@Souvikns @derberg
Should we close this PR as the bug related is already solved by #843 ?

derberg · 2024-04-10T12:18:40Z

closing as looks like not needed

Souvikns reviewed May 25, 2023

View reviewed changes

sambhavgupta0705 and others added 2 commits May 25, 2023 19:20

test

aa188b5

Signed-off-by: Sambhav Gupta <[email protected]>

chore(hook-setup): setup command-not-found hook for help command

479c31d

sambhavgupta0705 marked this pull request as ready for review May 25, 2023 14:57

Merge branch 'master' into oclif

e01eefc

sambhavgupta0705 requested review from magicmatatjahu, derberg, boyney123 and asyncapi-bot-eve as code owners May 25, 2023 14:57

kaushik-rishi reviewed May 25, 2023

View reviewed changes

fix: fixed the console command

6dc7d43

kaushik-rishi reviewed May 26, 2023

View reviewed changes

package-lock.json Outdated

Copy link

Contributor

kaushik-rishi May 26, 2023 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sambhavgupta0705
please revert the package-lock.json changes.

Merge branch 'master' into oclif

a903206

sambhavgupta0705 added 2 commits June 9, 2023 11:59

Merge branch 'master' into oclif

7e6379a

Merge branch 'master' into oclif

a1584fe

Merge branch 'master' into oclif

d83222a

ayushnau mentioned this pull request Oct 14, 2023

help command is not working #559

Closed

package_lock changes

1a3b5f7

Merge branch 'oclif' of github.com:sambhavgupta0705/cli into oclif

6a21479

derberg closed this Apr 10, 2024

	"./lib/hooks/command_not_found/example"
	"./lib/src/errors/command-not-found"

fix: help command #593

fix: help command #593

Conversation

sambhavgupta0705 commented May 25, 2023

Souvikns left a comment

Choose a reason for hiding this comment

Souvikns May 25, 2023

Choose a reason for hiding this comment

kaushik-rishi May 25, 2023

Choose a reason for hiding this comment

Souvikns May 25, 2023

Choose a reason for hiding this comment

kaushik-rishi May 25, 2023

Choose a reason for hiding this comment

kaushik-rishi commented May 25, 2023

Souvikns commented May 25, 2023 • edited Loading

kaushik-rishi commented May 25, 2023

sambhavgupta0705 commented May 25, 2023 • edited Loading

sambhavgupta0705 commented May 25, 2023

Souvikns commented May 25, 2023

kaushik-rishi commented May 25, 2023 • edited Loading

sambhavgupta0705 commented May 25, 2023

Souvikns commented May 25, 2023

kaushik-rishi commented May 25, 2023

kaushik-rishi commented May 25, 2023

sambhavgupta0705 commented May 25, 2023 • edited Loading

sambhavgupta0705 commented May 25, 2023

kaushik-rishi commented May 25, 2023

kaushik-rishi commented May 25, 2023

sambhavgupta0705 commented May 25, 2023

kaushik-rishi commented May 25, 2023 • edited Loading

kaushik-rishi May 25, 2023

Choose a reason for hiding this comment

sambhavgupta0705 May 25, 2023

Choose a reason for hiding this comment

Souvikns May 26, 2023

Choose a reason for hiding this comment

sambhavgupta0705 commented May 25, 2023

kaushik-rishi commented May 25, 2023

sambhavgupta0705 commented May 25, 2023

kaushik-rishi commented May 25, 2023

Souvikns commented May 26, 2023

kaushik-rishi commented May 26, 2023

kaushik-rishi May 26, 2023 • edited Loading

Choose a reason for hiding this comment

Souvikns commented May 26, 2023

kaushik-rishi commented May 26, 2023 • edited Loading

Souvikns commented Jun 6, 2023

kaushik-rishi commented Jun 6, 2023

sambhavgupta0705 commented Jun 8, 2023

sambhavgupta0705 commented Jun 10, 2023

sonarqubecloud bot commented Jun 21, 2023

kaushik-rishi commented Jun 22, 2023

derberg commented Jun 27, 2023

Souvikns commented Jul 19, 2023

sambhavgupta0705 commented Jul 19, 2023

Souvikns commented Sep 25, 2023

sambhavgupta0705 commented Sep 26, 2023

Souvikns commented Nov 29, 2023

sonarqubecloud bot commented Dec 15, 2023

Quality Gate passed

peter-rr commented Mar 21, 2024 • edited Loading

derberg commented Apr 10, 2024

Souvikns commented May 25, 2023 •

edited

Loading

sambhavgupta0705 commented May 25, 2023 •

edited

Loading

kaushik-rishi commented May 25, 2023 •

edited

Loading

sambhavgupta0705 commented May 25, 2023 •

edited

Loading

kaushik-rishi commented May 25, 2023 •

edited

Loading

kaushik-rishi May 26, 2023 •

edited

Loading

kaushik-rishi commented May 26, 2023 •

edited

Loading

peter-rr commented Mar 21, 2024 •

edited

Loading