Merge pull request #149 from Rustmail/148-convert-help-command-to-slash-command

feat(commands): add complete slash command for help command

Author: Akinator31

src/commands/help/mod.rs

@@ -0,0 +1,2 @@
+pub mod slash_command;
+pub mod text_command;

src/commands/help/slash_command/help.rs

@@ -0,0 +1,54 @@
+use crate::config::Config;
+use crate::errors::ModmailResult;
+use crate::i18n::get_translated_message;
+use crate::utils::command::defer_response::defer_response;
+use crate::utils::message::message_builder::MessageBuilder;
+use serenity::all::{CommandInteraction, Context, CreateCommand, ResolvedOption};
+
+pub async fn register(config: &Config) -> CreateCommand {
+    let cmd_desc = get_translated_message(
+        config,
+        "slash_command.help_command_description",
+        None,
+        None,
+        None,
+        None,
+    )
+    .await;
+
+    CreateCommand::new("help").description(cmd_desc)
+}
+
+pub async fn run(
+    ctx: &Context,
+    command: &CommandInteraction,
+    _options: &[ResolvedOption<'_>],
+    config: &Config,
+) -> ModmailResult<()> {
+    let help_message = "# Available commands:\n\n\
+        **!add_staff <staff_id>** - Add a staff to an hidden ticket\n\
+        **!remove_staff <staff_id>** - Remove a staff from a ticket\n\
+        **!alert** - Alert staff in the current thread when a new user answer arrives \n\
+        **!help** - Show this help message\n\
+        **!reply <message>** - Reply to a ticket\n\
+        **!annonreply <message>** - Reply anonymously to a ticket\n\
+        **!close [reason]** - Close the current thread with an optional reason\n\
+        **!delete [reason]** - Delete the current thread with an optional reason\n\
+        **!hide** - Make the current thread hidden to non-staff members\n\
+        **!new_thread <user_id>** - Create a new ticket with a specific user\n\
+        **!alert [cancel]** - Set or cancel an alert for staff in the current thread\n\
+        **!force_close** - Force close the current thread if it's orphaned\n\
+        **!id** - Show the user ID associated with the current thread";
+
+    defer_response(&ctx, &command).await?;
+
+    let response = MessageBuilder::system_message(ctx, config)
+        .content(help_message)
+        .to_channel(command.channel_id)
+        .build_interaction_message_followup()
+        .await;
+
+    let _ = command.create_followup(&ctx.http, response).await;
+
+    Ok(())
+}

src/commands/help/slash_command/mod.rs

@@ -0,0 +1 @@
+pub mod help;

src/commands/help.rs src/commands/help/text_command/help.rssrc/commands/help.rs renamed to src/commands/help/text_command/help.rs

@@ -1,7 +1,7 @@
-use serenity::all::{Context, Message};
 use crate::config::Config;
 use crate::errors::ModmailResult;
 use crate::utils::message::message_builder::MessageBuilder;
+use serenity::all::{Context, Message};
 
 pub async fn help(ctx: &Context, msg: &Message, config: &Config) -> ModmailResult<()> {
     let help_message = "# Available commands:\n\n\
@@ -26,4 +26,4 @@ pub async fn help(ctx: &Context, msg: &Message, config: &Config) -> ModmailResul
         .await?;
 
     Ok(())
-}
+}

src/commands/help/text_command/mod.rs

@@ -0,0 +1 @@
+pub mod help;

src/handlers/guild_interaction_handler.rs

@@ -4,6 +4,7 @@ use crate::commands::close::slash_command::close;
 use crate::commands::delete::slash_command::delete;
 use crate::commands::edit::slash_command::edit;
 use crate::commands::force_close::slash_command::force_close;
+use crate::commands::help::slash_command::help;
 use crate::commands::id::slash_command::id;
 use crate::commands::move_thread::slash_command::move_thread;
 use crate::commands::new_thread::slash_command::new_thread;
@@ -94,6 +95,9 @@ impl EventHandler for InteractionHandler {
                     "recover" => {
                         recover::run(&ctx, &command, &command.data.options(), &self.config).await
                     }
+                    "help" => {
+                        help::run(&ctx, &command, &command.data.options(), &self.config).await
+                    }
                     _ => Err(ModmailError::Command(CommandError::UnknownSlashCommand(
                         command.data.name.clone(),
                     ))),

src/handlers/guild_messages_handler.rs

@@ -6,6 +6,7 @@ use crate::commands::delete::text_command::delete::delete;
 use crate::commands::edit::message_ops::edit_inbox_message;
 use crate::commands::edit::text_command::edit::edit;
 use crate::commands::force_close::text_command::force_close::force_close;
+use crate::commands::help::text_command::help::help;
 use crate::commands::id::text_command::id::id;
 use crate::commands::move_thread::text_command::move_thread::move_thread;
 use crate::commands::new_thread::text_command::new_thread::new_thread;
@@ -34,7 +35,6 @@ use serenity::{
 use std::collections::HashSet;
 use std::sync::{LazyLock, Mutex};
 use std::{collections::HashMap, future::Future, pin::Pin, sync::Arc};
-use crate::commands::help::help;
 
 static SUPPRESSED_DELETES: LazyLock<Mutex<HashSet<u64>>> =
     LazyLock::new(|| Mutex::new(HashSet::new()));

src/handlers/ready_handler.rs

@@ -4,6 +4,7 @@ use crate::commands::close::slash_command::close;
 use crate::commands::delete::slash_command::delete;
 use crate::commands::edit::slash_command::edit;
 use crate::commands::force_close::slash_command::force_close;
+use crate::commands::help::slash_command::help;
 use crate::commands::id::slash_command::id;
 use crate::commands::move_thread::slash_command::move_thread;
 use crate::commands::new_thread::slash_command::new_thread;
@@ -68,6 +69,7 @@ impl EventHandler for ReadyHandler {
                     reply::register(&self.config).await,
                     delete::register(&self.config).await,
                     recover::register(&self.config).await,
+                    help::register(&self.config).await,
                 ],
             )
             .await;

src/i18n/language/en.rs

@@ -715,4 +715,8 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
             "Retrieve messages missed during the bot's downtime (This process is automatic).",
         ),
     );
+    dict.messages.insert(
+        "slash_command.help_command_description".to_string(),
+        DictionaryMessage::new("Show the help message"),
+    );
 }

src/i18n/language/fr.rs

@@ -726,4 +726,8 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
         "slash_command.recover_command_description".to_string(),
         DictionaryMessage::new("Récupérer les messages manqués pendant la période d'indisponibilité du bot (Ce processus est automatique)"),
     );
+    dict.messages.insert(
+        "slash_command.help_command_description".to_string(),
+        DictionaryMessage::new("Afficher le message d'aide"),
+    );
 }