commands/settings/HelpCommand.ts

/**
* This file is part of SudoBot.
* 
* Copyright (C) 2021-2022 OSN Inc.
*
* SudoBot is free software; you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by 
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* SudoBot is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of 
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License 
* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
*/

import { CommandInteraction, Message, MessageActionRow, MessageButton, Permissions } from 'discord.js';
import BaseCommand from '../../utils/structures/BaseCommand';
import DiscordClient from '../../client/Client';
import Help from '../../utils/Help';
import CommandOptions from '../../types/CommandOptions';
import InteractionOptions from '../../types/InteractionOptions';
import MessageEmbed from '../../client/MessageEmbed';
import { getAllCommandData, renderCommandMeta } from '../../services/CommandMetaDataManager';
import Pagination from '../../utils/Pagination';
import { fetchEmoji } from '../../utils/Emoji';

export default class HelpCommand extends BaseCommand {
    permissions = [Permissions.FLAGS.MANAGE_MESSAGES];

    constructor() {
        super('help', 'settings', ['?']);
        this.supportsInteractions = true;
    }

    async render() {
        let string = '';

        for (let cmd of Help) {
            string += `\n\n**${cmd.name}**\n${cmd.shortBrief}`;
        }

        return string;
    }

    async run(client: DiscordClient, message: Message | CommandInteraction, options: CommandOptions | InteractionOptions) {
        if ((options.isInteraction && !options.options.getString('command')) || (!options.isInteraction && options.args[0] === undefined)) {
            const commandData = getAllCommandData();

            const row = new MessageActionRow<MessageButton>()
                .addComponents(
                    new MessageButton()
                        .setLabel('Documentation')
                        .setURL('https://docs.sudobot.onesoftnet.eu.org')
                        .setStyle('LINK')
                        .setEmoji('📘'),
                    new MessageButton()
                        .setLabel('GitHub')
                        .setURL('https://github.com/onesoft-sudo/sudobot')
                        .setStyle('LINK')
                        .setEmoji((await fetchEmoji('github'))!)
                );

            const pagination = new Pagination(commandData, {
                channel_id: message.channel!.id,
                guild_id: message.guild!.id,
                limit: 10,
                user_id: message.member!.user.id,
                timeout: 120_000,
                messageOptions: {
                    components: [row]
                },
                embedBuilder({ data, maxPages, currentPage }) {
                    let description = `\`<...>\` means required argument and \`[...]\` means optional argument.\nRun \`${client.config.get('prefix')}help <CommandName>\` for more information about a specific command.\n\n`;

                    for (const { name, shortBrief } of data) {
                        description += `**${name}**\n`;
                        description += `${shortBrief}\n\n`;
                    }

                    return new MessageEmbed({
                        author: {
                            iconURL: client.user?.displayAvatarURL(),
                            name: "Help"
                        },
                        description,
                        footer: {
                            text: `Page ${currentPage} of ${maxPages} • ${commandData.length} commands total`
                        }
                    });
                },
            });
                
            const options = await pagination.getMessageOptions(1);
            let reply = await message.reply(options);

            if (message instanceof CommandInteraction) {
                reply = <Message> await message.fetchReply();
            }

            pagination.start(reply!).catch(console.error);

            return;
        }

        const commandName = options.isInteraction ? options.options.getString('command') : options.args[0];
        const cmd = Help.find(c => c.name === commandName);

        if (!cmd) {
            await message.reply({
                embeds: [
                    new MessageEmbed()
                    .setColor('#f14a60')
                    .setDescription(`Invalid command \`${commandName}\`.`)
                ]
            });

            return;
        }

        await message.reply({
            embeds: [renderCommandMeta(cmd)]
        });

        // let fields = [
        //     {
        //         name: "Usage",
        //         value: `\`${client.config.get('prefix')}${cmd.name}\`` + (cmd.structure.trim() !== '' ? ` \`${cmd.structure}\`` : '')
        //     },
        //     {
        //         name: 'Examples',
        //         value: cmd.example.replace(/\%\%/g, client.config.get('prefix'))
        //     }
        // ];

        // if (cmd.options !== undefined) {
        //     let str = '';

        //     for (let opt in cmd.options)
        //         str += `\`${opt}\` - ${cmd.options[opt]}\n`;

        //     str = str.substring(0, str.length - 1);

        //     fields.push({
        //         name: 'Options',
        //         value: str
        //     });
        // }

        // if (cmd.notes !== null) {
        //     fields.push({
        //         name: "Notes",
        //         value: cmd.notes
        //     });
        // }

        // await message.reply({
        //     embeds: [
        //         new MessageEmbed()
        //         .setTitle(`${client.config.get('prefix')}${cmd.name}`)
        //         .setDescription("`<...>` means required argument, `[...]` means optional argument.\n\n" + (cmd.description !== null ? cmd.description : cmd.shortBrief))
        //         .addFields(fields)
        //     ]
        // });
    }
}
1	/**
2	* This file is part of SudoBot.
3	*
4	* Copyright (C) 2021-2022 OSN Inc.
5	*
6	* SudoBot is free software; you can redistribute it and/or modify it
7	* under the terms of the GNU Affero General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* SudoBot is distributed in the hope that it will be useful, but
12	* WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU Affero General Public License for more details.
15	*
16	* You should have received a copy of the GNU Affero General Public License
17	* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18	*/
19
20	import { CommandInteraction, Message, MessageActionRow, MessageButton, Permissions } from 'discord.js';
21	import BaseCommand from '../../utils/structures/BaseCommand';
22	import DiscordClient from '../../client/Client';
23	import Help from '../../utils/Help';
24	import CommandOptions from '../../types/CommandOptions';
25	import InteractionOptions from '../../types/InteractionOptions';
26	import MessageEmbed from '../../client/MessageEmbed';
27	import { getAllCommandData, renderCommandMeta } from '../../services/CommandMetaDataManager';
28	import Pagination from '../../utils/Pagination';
29	import { fetchEmoji } from '../../utils/Emoji';
30
31	export default class HelpCommand extends BaseCommand {
32	permissions = [Permissions.FLAGS.MANAGE_MESSAGES];
33
34	constructor() {
35	super('help', 'settings', ['?']);
36	this.supportsInteractions = true;
37	}
38
39	async render() {
40	let string = '';
41
42	for (let cmd of Help) {
43	string += `\n\n${cmd.name}\n${cmd.shortBrief}`;
44	}
45
46	return string;
47	}
48
49	async run(client: DiscordClient, message: Message \| CommandInteraction, options: CommandOptions \| InteractionOptions) {
50	if ((options.isInteraction && !options.options.getString('command')) \|\| (!options.isInteraction && options.args[0] === undefined)) {
51	const commandData = getAllCommandData();
52
53	const row = new MessageActionRow<MessageButton>()
54	.addComponents(
55	new MessageButton()
56	.setLabel('Documentation')
57	.setURL('https://docs.sudobot.onesoftnet.eu.org')
58	.setStyle('LINK')
59	.setEmoji('📘'),
60	new MessageButton()
61	.setLabel('GitHub')
62	.setURL('https://github.com/onesoft-sudo/sudobot')
63	.setStyle('LINK')
64	.setEmoji((await fetchEmoji('github'))!)
65	);
66
67	const pagination = new Pagination(commandData, {
68	channel_id: message.channel!.id,
69	guild_id: message.guild!.id,
70	limit: 10,
71	user_id: message.member!.user.id,
72	timeout: 120_000,
73	messageOptions: {
74	components: [row]
75	},
76	embedBuilder({ data, maxPages, currentPage }) {
77	let description = `\`<...>\` means required argument and \`[...]\` means optional argument.\nRun \`${client.config.get('prefix')}help <CommandName>\` for more information about a specific command.\n\n`;
78
79	for (const { name, shortBrief } of data) {
80	description += `${name}\n`;
81	description += `${shortBrief}\n\n`;
82	}
83
84	return new MessageEmbed({
85	author: {
86	iconURL: client.user?.displayAvatarURL(),
87	name: "Help"
88	},
89	description,
90	footer: {
91	text: `Page ${currentPage} of ${maxPages} • ${commandData.length} commands total`
92	}
93	});
94	},
95	});
96
97	const options = await pagination.getMessageOptions(1);
98	let reply = await message.reply(options);
99
100	if (message instanceof CommandInteraction) {
101	reply = <Message> await message.fetchReply();
102	}
103
104	pagination.start(reply!).catch(console.error);
105
106	return;
107	}
108
109	const commandName = options.isInteraction ? options.options.getString('command') : options.args[0];
110	const cmd = Help.find(c => c.name === commandName);
111
112	if (!cmd) {
113	await message.reply({
114	embeds: [
115	new MessageEmbed()
116	.setColor('#f14a60')
117	.setDescription(`Invalid command \`${commandName}\`.`)
118	]
119	});
120
121	return;
122	}
123
124	await message.reply({
125	embeds: [renderCommandMeta(cmd)]
126	});
127
128	// let fields = [
129	// {
130	// name: "Usage",
131	// value: `\`${client.config.get('prefix')}${cmd.name}\`` + (cmd.structure.trim() !== '' ? ` \`${cmd.structure}\`` : '')
132	// },
133	// {
134	// name: 'Examples',
135	// value: cmd.example.replace(/\%\%/g, client.config.get('prefix'))
136	// }
137	// ];
138
139	// if (cmd.options !== undefined) {
140	// let str = '';
141
142	// for (let opt in cmd.options)
143	// str += `\`${opt}\` - ${cmd.options[opt]}\n`;
144
145	// str = str.substring(0, str.length - 1);
146
147	// fields.push({
148	// name: 'Options',
149	// value: str
150	// });
151	// }
152
153	// if (cmd.notes !== null) {
154	// fields.push({
155	// name: "Notes",
156	// value: cmd.notes
157	// });
158	// }
159
160	// await message.reply({
161	// embeds: [
162	// new MessageEmbed()
163	// .setTitle(`${client.config.get('prefix')}${cmd.name}`)
164	// .setDescription("`<...>` means required argument, `[...]` means optional argument.\n\n" + (cmd.description !== null ? cmd.description : cmd.shortBrief))
165	// .addFields(fields)
166	// ]
167	// });
168	}
169	}