Merge pull request #222 from Rustmail/221-rework-help-command

refactor(commands): add 'command' argument to help command

Author: Akinator31

rustmail/src/commands/help/common.rs

@@ -0,0 +1,93 @@
+use crate::commands::CommandRegistry;
+use crate::config::Config;
+use crate::errors::{CommandError, ModmailError, ModmailResult};
+use crate::i18n::get_translated_message;
+use crate::utils::message::message_builder::MessageBuilder;
+use serenity::all::{CommandInteraction, Context, Message};
+use std::sync::Arc;
+
+pub async fn display_commands_list(
+    ctx: &Context,
+    config: &Config,
+    registry: Arc<CommandRegistry>,
+    msg: Option<&Message>,
+    command: Option<&CommandInteraction>,
+) -> ModmailResult<()> {
+    let mut docs_message = String::new();
+
+    let welcome_msg = get_translated_message(&config, "help.message", None, None, None, None).await;
+    docs_message.push_str(&welcome_msg);
+
+    for (name, _) in &registry.commands {
+        docs_message.push_str(&format!("- **{}**\n", name))
+    }
+
+    if let Some(msg) = msg {
+        let _ = MessageBuilder::system_message(&ctx, config)
+            .content(docs_message)
+            .to_channel(msg.channel_id)
+            .send(true)
+            .await;
+
+        return Ok(());
+    }
+
+    if let Some(command) = command {
+        let response = MessageBuilder::system_message(&ctx, config)
+            .content(docs_message)
+            .to_channel(command.channel_id)
+            .build_interaction_message_followup()
+            .await;
+
+        command.create_followup(&ctx.http, response).await?;
+
+        return Ok(());
+    }
+
+    println!("No valid message or command interaction provided.");
+    Ok(())
+}
+
+pub async fn display_command_help(
+    ctx: &Context,
+    config: &Config,
+    registry: Arc<CommandRegistry>,
+    msg: Option<&Message>,
+    command: Option<&CommandInteraction>,
+    command_name: &str,
+) -> ModmailResult<()> {
+    if let Some(cmd) = registry.commands.get(command_name) {
+        let command_doc = cmd.doc(config).await;
+        let mut docs_message = String::new();
+        docs_message.push_str(&format!("**{}**\n\n", command_name));
+        docs_message.push_str(&command_doc);
+
+        if let Some(msg) = msg {
+            let _ = MessageBuilder::system_message(&ctx, config)
+                .content(docs_message)
+                .to_channel(msg.channel_id)
+                .send(true)
+                .await;
+
+            return Ok(());
+        }
+
+        if let Some(command) = command {
+            let response = MessageBuilder::system_message(&ctx, config)
+                .content(docs_message)
+                .to_channel(command.channel_id)
+                .build_interaction_message_followup()
+                .await;
+
+            command.create_followup(&ctx.http, response).await?;
+            return Ok(());
+        }
+
+        println!("No valid message or command interaction provided.");
+        Ok(())
+    } else {
+        Err(ModmailError::Command(CommandError::UnknownCommand(
+            format!("{}", command_name),
+        )))
+    }
+}

rustmail/src/commands/help/mod.rs

@@ -1,2 +1,3 @@
+pub mod common;
 pub mod slash_command;
 pub mod text_command;

rustmail/src/commands/help/slash_command/help.rs

@@ -1,15 +1,15 @@
+use crate::commands::help::common::{display_command_help, display_commands_list};
 use crate::commands::{BoxFuture, RegistrableCommand};
 use crate::config::Config;
 use crate::errors::ModmailResult;
 use crate::handlers::guild_interaction_handler::InteractionHandler;
 use crate::i18n::get_translated_message;
 use crate::utils::command::defer_response::defer_response;
-use crate::utils::message::message_builder::MessageBuilder;
+use serenity::all::{
+    CommandDataOptionValue, CommandInteraction, CommandOptionType, Context, CreateCommand,
+    CreateCommandOption, ResolvedOption,
+};
 use serenity::FutureExt;
-use serenity::all::{CommandInteraction, Context, CreateCommand, ResolvedOption};
-use serenity::futures::future::join_all;
-use std::collections::HashMap;
-use std::error::Error;
 use std::sync::Arc;
 
 pub struct HelpCommand;
@@ -38,8 +38,22 @@ impl RegistrableCommand for HelpCommand {
                 None,
             )
             .await;
+            let cmd_arg_desc = get_translated_message(
+                &config,
+                "slash_command.help_command_argument_desc",
+                None,
+                None,
+                None,
+                None,
+            )
+            .await;
 
-            vec![CreateCommand::new("help").description(cmd_desc)]
+            vec![
+                CreateCommand::new("help").description(cmd_desc).add_option(
+                    CreateCommandOption::new(CommandOptionType::String, "command", cmd_arg_desc)
+                        .required(false),
+                ),
+            ]
         })
     }
 
@@ -56,33 +70,41 @@ impl RegistrableCommand for HelpCommand {
         let config = config.clone();
 
         Box::pin(async move {
-            let mut docs_message = String::new();
-
-            let welcome_msg =
-                get_translated_message(&config, "help.message", None, None, None, None).await;
-            docs_message.push_str(&welcome_msg);
-
-            let futures = handler.registry.commands.iter().map(|(name, command)| {
-                let config = config.clone();
-
-                async move {
-                    let doc = command.doc(&config).await;
-                    format!("**{}** — {}\n\n", name, doc)
-                }
-            });
-
-            let results = join_all(futures).await;
-            docs_message.push_str(&results.join(""));
-
             defer_response(&ctx, &command).await?;
 
-            let response = MessageBuilder::system_message(&ctx, &config)
-                .content(docs_message)
-                .to_channel(command.channel_id)
-                .build_interaction_message_followup()
-                .await;
+            let mut command_name: Option<String> = None;
 
-            let _ = command.create_followup(&ctx.http, response).await;
+            for option in &command.data.options {
+                match option.name.as_str() {
+                    "command" => {
+                        if let CommandDataOptionValue::String(val) = &option.value {
+                            command_name.replace(val.clone());
+                        }
+                    }
+                    _ => {}
+                }
+            }
+
+            if let Some(cmd_name) = command_name {
+                display_command_help(
+                    &ctx,
+                    &config,
+                    handler.registry.clone(),
+                    None,
+                    Some(&command),
+                    &cmd_name,
+                )
+                .await?;
+            } else {
+                display_commands_list(
+                    &ctx,
+                    &config,
+                    handler.registry.clone(),
+                    None,
+                    Some(&command),
+                )
+                .await?;
+            }
 
             Ok(())
         })

rustmail/src/commands/help/text_command/help.rs

@@ -1,29 +1,36 @@
+use crate::commands::help::common::{display_command_help, display_commands_list};
 use crate::config::Config;
 use crate::errors::ModmailResult;
 use crate::handlers::guild_messages_handler::GuildMessagesHandler;
-use crate::utils::message::message_builder::MessageBuilder;
 use serenity::all::{Context, Message};
 use std::sync::Arc;
 
+fn extract_request_command_name(command: &str) -> &str {
+    let parts: Vec<&str> = command.trim().split_whitespace().collect();
+    if parts.len() > 1 { parts[1] } else { "" }
+}
+
 pub async fn help(
     ctx: Context,
     msg: Message,
     config: &Config,
     handler: Arc<GuildMessagesHandler>,
 ) -> ModmailResult<()> {
-    let mut docs_message = String::new();
-
-    for (name, command) in &handler.registry.commands {
-        let doc = command.doc(&config).await;
+    let command_name = extract_request_command_name(&msg.content);
 
-        docs_message.push_str(&format!("**{}** — {}\n\n", name, doc))
-    }
-
-    MessageBuilder::system_message(&ctx, config)
-        .content(docs_message)
-        .to_channel(msg.channel_id)
-        .send(true)
+    if command_name.is_empty() {
+        display_commands_list(&ctx, config, handler.registry.clone(), Some(&msg), None).await?;
+    } else {
+        display_command_help(
+            &ctx,
+            config,
+            handler.registry.clone(),
+            Some(&msg),
+            None,
+            command_name,
+        )
         .await?;
+    }
 
     Ok(())
 }

rustmail/src/i18n/language/en.rs

@@ -835,7 +835,7 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
     );
     dict.messages.insert(
         "help.help".to_string(),
-        DictionaryMessage::new("Displays a list of all available commands with a short description. To view the help message, use `!help`."),
+        DictionaryMessage::new("Displays a list of all available commands with a short description. To view the help message, use `!help`. If you want help with a specific command, type `!help <command_name>`."),
     );
     dict.messages.insert(
         "help.id".to_string(),
@@ -871,7 +871,7 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
     );
     dict.messages.insert(
         "help.message".to_string(),
-        DictionaryMessage::new("## Commands:\n\n**All commands** are also available as **__slash commands__** with the **__same name__**.\n\n"),
+        DictionaryMessage::new("## Commands:\n\n**All commands** are also available as **__slash commands__** with the **__same name__**.\n\nIf you want help with a specific command, type `!help <command_name>`.\n\n"),
     );
     dict.messages.insert(
         "help.take".to_string(),
@@ -922,4 +922,8 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
         "release.confirmation".to_string(),
         DictionaryMessage::new("The ticket has been released by {staff}."),
     );
+    dict.messages.insert(
+        "slash_command.help_command_argument_desc".to_string(),
+        DictionaryMessage::new("The command to get help with"),
+    );
 }

rustmail/src/i18n/language/fr.rs

@@ -859,7 +859,7 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
     );
     dict.messages.insert(
         "help.help".to_string(),
-        DictionaryMessage::new("Affiche une liste de toutes les commandes disponibles avec une brève description. Pour afficher le message d'aide, faites `!help`."),
+        DictionaryMessage::new("Affiche une liste de toutes les commandes disponibles avec une brève description. Pour afficher le message d'aide, faites `!help`. Si vous souhaitez obtenir de l'aide sur une commande spécifique, faites `!help <nom_de_la_commande>`."),
     );
     dict.messages.insert(
         "help.id".to_string(),
@@ -895,7 +895,7 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
     );
     dict.messages.insert(
         "help.message".to_string(),
-        DictionaryMessage::new("## Commandes :\n\n**Toutes les commandes** disponibles sont également utilisables via des **__commandes slash__** portant le __même nom__.\n\n"),
+        DictionaryMessage::new("## Commandes :\n\n**Toutes les commandes** disponibles sont également utilisables via des **__commandes slash__** portant le __même nom__.\n\nSi vous souhaitez obtenir de l'aide sur une commande spécifique, faites `!help <nom_de_la_commande>`.\n\n")
     );
     dict.messages.insert(
         "help.take".to_string(),
@@ -937,4 +937,8 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
         "release.confirmation".to_string(),
         DictionaryMessage::new("Le ticket n'est plus pris en charge par {staff}."),
     );
+    dict.messages.insert(
+        "slash_command.help_command_argument_desc".to_string(),
+        DictionaryMessage::new("Le nom de la commande pour laquelle vous souhaitez de l'aide"),
+    );
 }