poise 0.6.2

A Discord bot framework for serenity
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277

//! Contains a built-in help command and surrounding infrastructure that uses embeds.

use crate::{serenity_prelude as serenity, CreateReply};
use std::fmt::Write as _;

/// Optional configuration for how the help message from [`pretty_help()`] looks
pub struct PrettyHelpConfiguration<'a> {
    /// Extra text displayed at the bottom of your message. Can be used for help and tips specific
    /// to your bot
    pub extra_text_at_bottom: &'a str,
    /// Whether to make the response ephemeral if possible. Can be nice to reduce clutter
    pub ephemeral: bool,
    /// Whether to list context menu commands as well
    pub show_context_menu_commands: bool,
    /// Whether to list context menu commands as well
    pub show_subcommands: bool,
    /// Whether to include [`crate::Command::description`] (above [`crate::Command::help_text`]).
    pub include_description: bool,
    /// Color of the Embed
    pub color: (u8, u8, u8),
    #[doc(hidden)]
    pub __non_exhaustive: (),
}

impl Default for PrettyHelpConfiguration<'_> {
    fn default() -> Self {
        Self {
            extra_text_at_bottom: "",
            ephemeral: true,
            show_context_menu_commands: false,
            show_subcommands: false,
            include_description: true,
            color: (0, 110, 51),
            __non_exhaustive: (),
        }
    }
}

/// A help command that works similarly to `builtin::help` but outputs text in an embed.
///
pub async fn pretty_help<U, E>(
    ctx: crate::Context<'_, U, E>,
    command: Option<&str>,
    config: PrettyHelpConfiguration<'_>,
) -> Result<(), serenity::Error> {
    match command {
        Some(command) => pretty_help_single_command(ctx, command, config).await,
        None => pretty_help_all_commands(ctx, config).await,
    }
}

/// Printing an overview of all commands (e.g. `~help`)
async fn pretty_help_all_commands<U, E>(
    ctx: crate::Context<'_, U, E>,
    config: PrettyHelpConfiguration<'_>,
) -> Result<(), serenity::Error> {
    let commands = ctx.framework().options().commands.iter().filter(|cmd| {
        !cmd.hide_in_help
            && (cmd.prefix_action.is_some()
                || cmd.slash_action.is_some()
                || (cmd.context_menu_action.is_some() && config.show_context_menu_commands))
    });

    let mut categories = indexmap::IndexMap::<Option<&str>, Vec<&crate::Command<U, E>>>::new();
    for cmd in commands {
        categories
            .entry(cmd.category.as_deref())
            .or_default()
            .push(cmd);
    }

    let options_prefix = super::help::get_prefix_from_options(ctx).await;

    let fields = categories
        .into_iter()
        .filter(|(_, cmds)| !cmds.is_empty())
        .map(|(category, mut cmds)| {
            // get context menu items at the bottom
            cmds.sort_by_key(|cmd| cmd.slash_action.is_none() && cmd.prefix_action.is_none());

            let mut buffer = String::new();

            for cmd in cmds {
                let name = cmd.context_menu_name.as_deref().unwrap_or(&cmd.name);
                let prefix = format_cmd_prefix(cmd, &options_prefix);

                if let Some(description) = cmd.description.as_deref() {
                    writeln!(buffer, "{}{}`: *{}*", prefix, name, description).ok();
                } else {
                    writeln!(buffer, "{}{}`.", prefix, name).ok();
                }

                if config.show_subcommands {
                    for sbcmd in &cmd.subcommands {
                        let name = sbcmd.context_menu_name.as_deref().unwrap_or(&sbcmd.name);
                        let prefix = format_cmd_prefix(sbcmd, &options_prefix);

                        if let Some(description) = sbcmd.description.as_deref() {
                            writeln!(buffer, "> {}{}`: *{}*", prefix, name, description).ok();
                        } else {
                            writeln!(buffer, "> {}{}`.", prefix, name).ok();
                        }
                    }
                }
            }
            if let Some((i, _)) = buffer.char_indices().nth(1024) {
                buffer.truncate(i);
            }
            (category.unwrap_or_default(), buffer, false)
        })
        .collect::<Vec<_>>();

    let embed = serenity::CreateEmbed::new()
        .title("Help")
        .fields(fields)
        .color(config.color)
        .footer(serenity::CreateEmbedFooter::new(
            config.extra_text_at_bottom,
        ));

    let reply = crate::CreateReply::default()
        .embed(embed)
        .ephemeral(config.ephemeral);

    ctx.send(reply).await?;

    Ok(())
}

/// Figures out which prefix a command should have
fn format_cmd_prefix<U, E>(cmd: &crate::Command<U, E>, options_prefix: &Option<String>) -> String {
    if cmd.slash_action.is_some() {
        "`/".into()
    } else if cmd.prefix_action.is_some() {
        format!("`{}", options_prefix.as_deref().unwrap_or_default())
    } else if cmd.context_menu_action.is_some() {
        match cmd.context_menu_action {
            Some(crate::ContextMenuCommandAction::Message(_)) => "Message menu: `".into(),
            Some(crate::ContextMenuCommandAction::User(_)) => "User menu: `".into(),
            Some(crate::ContextMenuCommandAction::__NonExhaustive) | None => {
                unreachable!()
            }
        }
    } else {
        "`".into()
    }
}

/// Code for printing help of a specific command (e.g. `~help my_command`)
async fn pretty_help_single_command<U, E>(
    ctx: crate::Context<'_, U, E>,
    command_name: &str,
    config: PrettyHelpConfiguration<'_>,
) -> Result<(), serenity::Error> {
    let commands = &ctx.framework().options().commands;

    // Try interpret the command name as a context menu command first
    let command = commands
        .iter()
        .find(|cmd| {
            cmd.context_menu_name
                .as_ref()
                .is_some_and(|n| n.eq_ignore_ascii_case(command_name))
        })
        // Then interpret command name as a normal command (possibly nested subcommand)
        .or(crate::find_command(commands, command_name, true, &mut vec![]).map(|(c, _, _)| c));

    let Some(command) = command else {
        ctx.send(
            CreateReply::default()
                .content(format!("No such command `{}`", command_name))
                .ephemeral(config.ephemeral),
        )
        .await?;

        return Ok(());
    };

    let mut invocations = Vec::new();
    let mut subprefix = None;

    if command.slash_action.is_some() {
        invocations.push(format!("`/{}`", command.name));
        subprefix = Some(format!("> `/{}`", command.name));
    }
    if command.prefix_action.is_some() {
        let prefix = super::help::get_prefix_from_options(ctx)
            .await
            // This can happen if the prefix is dynamic, and the callback fails
            // due to help being invoked with slash or context menu commands.
            .unwrap_or_else(|| String::from("<prefix>"));
        invocations.push(format!("`{}{}`", prefix, command.name));
        subprefix = subprefix.or(Some(format!("> `{}{}`", prefix, command.name)));
    }
    if command.context_menu_name.is_some() && command.context_menu_action.is_some() {
        let kind = match command.context_menu_action {
            Some(crate::ContextMenuCommandAction::User(_)) => "user",
            Some(crate::ContextMenuCommandAction::Message(_)) => "message",
            Some(crate::ContextMenuCommandAction::__NonExhaustive) | None => unreachable!(),
        };
        invocations.push(format!(
            "`{}` (on {})",
            command
                .context_menu_name
                .as_deref()
                .unwrap_or(&command.name),
            kind
        ));
        subprefix = subprefix.or(Some(String::from("> ")));
    }
    // At least one of the three if blocks should have triggered
    assert!(!invocations.is_empty());
    assert!(subprefix.is_some());

    let invocations = invocations
        .into_iter()
        .reduce(|x, y| format!("{x}\n{y}"))
        .map(|s| ("", s, false));

    let description = match (&command.description, &command.help_text) {
        (Some(description), Some(help_text)) if config.include_description => {
            format!("{}\n\n{}", description, help_text)
        }
        (_, Some(help_text)) => help_text.clone(),
        (Some(description), None) => description.clone(),
        (None, None) => "No help available".to_string(),
    };

    let parameters = command
        .parameters
        .iter()
        .map(|parameter| {
            let req = if parameter.required {
                "required"
            } else {
                "optional"
            };
            if let Some(description) = parameter.description.as_deref() {
                format!("`{}` ({}) *{} *.", parameter.name, req, description)
            } else {
                format!("`{}` ({}).", parameter.name, req)
            }
        })
        .reduce(|x, y| format!("{x}\n{y}"))
        .map(|s| ("Parameters", s, false));

    let sbcmds = command
        .subcommands
        .iter()
        .map(|sbcmd| {
            let prefix = format_cmd_prefix(sbcmd, &subprefix); // i have no idea about this really
            let name = sbcmd.context_menu_name.as_deref().unwrap_or(&sbcmd.name);
            if let Some(description) = sbcmd.description.as_deref() {
                format!("> {}{}`: *{} *", prefix, name, description)
            } else {
                format!("> {}{}`", prefix, name,)
            }
        })
        .reduce(|x, y| format!("{x}\n{y}"))
        .map(|s| ("Subcommands", s, false));

    let fields = invocations
        .into_iter()
        .chain(parameters.into_iter())
        .chain(sbcmds.into_iter());

    let embed = serenity::CreateEmbed::default()
        .description(description)
        .fields(fields);

    let reply = CreateReply::default()
        .embed(embed)
        .ephemeral(config.ephemeral);

    ctx.send(reply).await?;
    Ok(())
}