Add a command to show list of supported commands #396

Amnish04 · 2024-02-01T21:54:13Z

Currently, when a user enters an unsupported command, a toast message is displayed suggesting the commands was invalid.

I have added a new command called /commands that allows users to quickly refer to the list of commands instead of the general /help command.

The list of commands is also displayed when an invalid command is entered instead of showing the toast message.

This fixes #356

rjwignar

The feature works, and the code looks great!
I've added some general comments but the only change I require before approving this is updating the Commands section of the helpText constant in src/components/Message/AppMessage/Help.tsx to include a description for your new command.

rjwignar · 2024-02-02T01:42:53Z

src/Chat/ChatBase.tsx

+          } catch (err: any) {
+            error({
+              title: `Unknown Command`,
+              message: `Command not recognized. Use /help to get help on valid commands.`,
+            });


Just curious. Since you've added logic for the /commands command, is there any circumstance where this Toast message would appear?

That is just a fallback if for some reason, the execution of /commands command runs into an exception (which I don't think should ever happen).

Should we remove it?

"Should never happen" is not the same as "Is impossible." I'd leave it so we don't crash. If it never shows the error toast, that's fine.

You're right. I did not remove it, but changed the wording to be same as if it happened with any other command since the Unknown Command toast is always shown now

src/components/Message/AppMessage/Help.tsx

rjwignar · 2024-02-02T01:59:29Z

src/components/Message/AppMessage/Help.tsx

+| Command | Description |
+|-----|------|
+| /help         | Shows this help message. |
+| /commands | Shows a list of **supported commands** in ChatCraft |
+| /new          | Creates a new chat. |
+| /clear        | Erases all messages in the current chat. |
+| /summary&nbsp;[max-length] | Uses ChatGPT to create a summary of the current chat. Optionally takes a maximum word length (defaults to 500). |
+| /import&nbsp;<url> | Loads the provided URL and imports the text. Where possible, ChatCraft will try to get raw text vs. HTML from sites like GitHub. NOTE: to prevent abuse, you must be logged into use the import command. |`;


The commands list in helpText should be updated to include your new /commands command(Lines 91-97), as you've done here

Sure, I missed that. Thanks for noticing

tarasglek · 2024-02-02T03:11:14Z

src/Chat/ChatBase.tsx

+            forceScroll();
+          } catch (err: any) {
+            error({
+              title: `Unknown Command`,


Why is /commands better than showing /help with all commands?

We should show the command that we failed to identify. I get a lot of errors from chatcraft when i try to paste /something and it's not immediately obvious without an indicator of what i typed

it reminds me of

We should show the command that we failed to identify. I get a lot of errors from chatcraft when i try to paste /something and it's not immediately obvious without an indicator of what i typed

That's a good point.
Would it be better to have that indicated in /commands or inside the original Toast error message we currently have in the main branch?
Something like below?

/commands

Toast Message:

@tarasglek The /help command displays all the general help information related to ChatCraft. So it gets a little harder for user to skim through and find the supported commands.

Using /commands, it just becomes a little more convenient to look them up.

But you're right, we should also show the command that we typed as its not even added to the chat.

@rjwignar I think we should add it to the toast message?

@mingming-ma I like the idea of suggesting a similar command. Should we have a separate issue for that?

cloudflare-pages · 2024-02-02T17:42:30Z

Deploying with Cloudflare Pages

Latest commit:	`8a8d1ae`
Status:	✅ Deploy successful!
Preview URL:	https://86bc40f9.console-overthinker-dev.pages.dev
Branch Preview URL:	https://amnish04-issue356.console-overthinker-dev.pages.dev

View logs

Amnish04 · 2024-02-02T17:42:31Z

Just pushed some changes. I've restored the toast message for Unknown Command and now it also displays what command was typed. The list of commands is also displayed.

rjwignar

I like how the toast message displays the unrecognized command now.

With these changes, ChatCraft will now display both a Toast error message print the list of commands (by invoking /commands) when an unrecognized command is sent:
.

These changes have my approval, but I'd like to see how others feel about both being displayed. @humphd, @mingming-ma, what are your thoughts on this?

mingming-ma

For the most similar commands, I think it might be not so helpful if we have all commands displayed. I think we can import the commandsHelpText to Help so when new commands coming in we don't need to change twice

mingming-ma · 2024-02-02T22:26:02Z

src/components/Message/AppMessage/Help.tsx

 | Command | Description |
 |-----|------|
 | /help         | Shows this help message. |
+| /commands | Shows a list of **supported commands** in ChatCraft |
 | /new          | Creates a new chat. |
 | /clear        | Erases all messages in the current chat. |
 | /summary&nbsp;[max-length] | Uses ChatGPT to create a summary of the current chat. Optionally takes a maximum word length (defaults to 500). |


Suggested change

| Command | Description |

|-----|------|

| /help | Shows this help message. |

| /commands | Shows a list of **supported commands** in ChatCraft |

| /new | Creates a new chat. |

| /clear | Erases all messages in the current chat. |

| /summary [max-length] | Uses ChatGPT to create a summary of the current chat. Optionally takes a maximum word length (defaults to 500). |

${commandsHelpText}

@mingming-ma Agreed, I'll commit that.

tarasglek · 2024-02-03T16:23:57Z

I don't think we need to toast here, how about we show the error inline in the commands help message reply?

Amnish04 · 2024-02-05T18:49:17Z

I don't think we need to toast here, how about we show the error inline in the commands help message reply?

Yes, I think that makes more sense.

Amnish04 · 2024-02-07T05:34:34Z

@tarasglek Just pushed the changes.

Any invalid command now shows up inline with the commands help text.

Here are the scenarios:

1. /typo

2. /commands

3. /commands query-some-command

I am now allowing the CommandsHelpCommand to accept arguments which we can later use to implement a suggest closest command feature based on @mingming-ma's suggestion.

My only concern is if I could use a simpler approach for this.

tarasglek · 2024-02-07T16:06:03Z

lgtm

Amnish04 · 2024-02-07T17:26:01Z

@mingming-ma @rjwignar If you guys also think this is good, should I merge?

mingming-ma · 2024-02-07T20:11:24Z

lgtm

rjwignar

Changes look great! LGTM

Amnish04 · 2024-02-07T21:32:34Z

Thanks for reviewing everyone!

Amnish04 self-assigned this Feb 1, 2024

rjwignar requested review from rjwignar and mingming-ma February 1, 2024 22:10

rjwignar requested changes Feb 2, 2024

View reviewed changes

tarasglek reviewed Feb 2, 2024

View reviewed changes

rjwignar approved these changes Feb 2, 2024

View reviewed changes

mingming-ma reviewed Feb 2, 2024

View reviewed changes

Amnish04 added 3 commits February 3, 2024 14:41

Add a command to show list of supported commands

c8058af

Display a toast message indicating the incorrect command

b061310

Single source of truth for commands help text

84273dc

Amnish04 force-pushed the amnish04/issue356 branch from 25eca6a to 84273dc Compare February 5, 2024 18:50

Show the invalid command inline with commands help text

8a8d1ae

humphd requested review from mingming-ma and rjwignar February 7, 2024 12:53

rjwignar approved these changes Feb 7, 2024

View reviewed changes

Amnish04 merged commit a1ab665 into main Feb 7, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a command to show list of supported commands #396

Add a command to show list of supported commands #396

Amnish04 commented Feb 1, 2024

rjwignar left a comment

rjwignar Feb 2, 2024

Amnish04 Feb 2, 2024

humphd Feb 2, 2024

Amnish04 Feb 2, 2024

rjwignar Feb 2, 2024

Amnish04 Feb 2, 2024

tarasglek Feb 2, 2024

mingming-ma Feb 2, 2024

rjwignar Feb 2, 2024 •

edited

Amnish04 Feb 2, 2024

cloudflare-pages bot commented Feb 2, 2024 •

edited

Amnish04 commented Feb 2, 2024

rjwignar left a comment

mingming-ma left a comment

mingming-ma Feb 2, 2024

Amnish04 Feb 2, 2024

tarasglek commented Feb 3, 2024

Amnish04 commented Feb 5, 2024

Amnish04 commented Feb 7, 2024 •

edited

tarasglek commented Feb 7, 2024 •

edited

Amnish04 commented Feb 7, 2024

mingming-ma commented Feb 7, 2024

rjwignar left a comment

Amnish04 commented Feb 7, 2024

Add a command to show list of supported commands #396

Add a command to show list of supported commands #396

Conversation

Amnish04 commented Feb 1, 2024

rjwignar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rjwignar Feb 2, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cloudflare-pages bot commented Feb 2, 2024 • edited

Deploying with Cloudflare Pages

Amnish04 commented Feb 2, 2024

rjwignar left a comment

Choose a reason for hiding this comment

mingming-ma left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tarasglek commented Feb 3, 2024

Amnish04 commented Feb 5, 2024

Amnish04 commented Feb 7, 2024 • edited

tarasglek commented Feb 7, 2024 • edited

Amnish04 commented Feb 7, 2024

mingming-ma commented Feb 7, 2024

rjwignar left a comment

Choose a reason for hiding this comment

Amnish04 commented Feb 7, 2024

rjwignar Feb 2, 2024 •

edited

cloudflare-pages bot commented Feb 2, 2024 •

edited

Amnish04 commented Feb 7, 2024 •

edited

tarasglek commented Feb 7, 2024 •

edited