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
|
import { BushCommand, type ArgType, type BushMessage, type BushSlashMessage } from '#lib';
import { ButtonBuilder } from '@discordjs/builders';
import assert from 'assert';
import {
ActionRowBuilder,
ApplicationCommandOptionType,
AutocompleteInteraction,
ButtonStyle,
EmbedBuilder,
PermissionFlagsBits
} from 'discord.js';
import Fuse from 'fuse.js';
import packageDotJSON from '../../../package.json' assert { type: 'json' };
import { stripIndent } from '../../lib/common/tags.js';
assert(Fuse);
assert(packageDotJSON);
export default class HelpCommand extends BushCommand {
public constructor() {
super('help', {
aliases: ['help'],
category: 'info',
description: 'Displays a list of commands, or detailed information for a specific command.',
usage: ['help [command]'],
examples: ['help prefix'],
args: [
{
id: 'command',
description: 'The command to show info about.',
type: 'commandAlias',
match: 'content',
prompt: 'What command do you need help with?',
retry: '{error} Choose a valid command to find help for.',
slashType: ApplicationCommandOptionType.String,
optional: true,
autocomplete: true
},
{
id: 'showHidden',
description: 'Whether ot not to show hidden commands as well.',
match: 'flag',
flag: '--hidden',
slashType: ApplicationCommandOptionType.Boolean,
ownerOnly: true,
only: 'text',
optional: true
}
],
slash: true,
clientPermissions: (m) => util.clientSendAndPermCheck(m, [PermissionFlagsBits.EmbedLinks], true),
userPermissions: []
});
}
public override async exec(message: BushMessage | BushSlashMessage, args: HelpArgs) {
const row = this.addLinks(message);
const command = args.command
? typeof args.command === 'string'
? client.commandHandler.findCommand(args.command) ?? null
: args.command
: null;
if (!message.author.isOwner()) args.showHidden = false;
if (!command || command.pseudo) {
return this.helpAll(message, args, row);
} else {
return this.helpIndividual(message, row, command);
}
}
private helpAll(message: BushMessage | BushSlashMessage, args: HelpArgs, row: ActionRowBuilder<ButtonBuilder>) {
const prefix = util.prefix(message);
const embed = new EmbedBuilder()
.setColor(util.colors.default)
.setTimestamp()
.setFooter({ text: `For more information about a command use ${prefix}help <command>` });
for (const [, category] of this.handler.categories) {
const categoryFilter = category.filter((command) => {
if (command.pseudo) return false;
if (command.hidden && !args.showHidden) return false;
if (command.channel == 'guild' && !message.guild && !args.showHidden) return false;
if (command.ownerOnly && !message.author.isOwner()) return false;
if (command.superUserOnly && !message.author.isSuperUser()) return false;
if (command.restrictedGuilds?.includes(message.guild?.id ?? '') === false && !args.showHidden) return false;
if (command.aliases.length === 0) return false;
return true;
});
const categoryNice = category.id
.replace(/(\b\w)/gi, (lc) => lc.toUpperCase())
.replace(/'(S)/g, (letter) => letter.toLowerCase());
const categoryCommands = categoryFilter.filter((cmd) => cmd.aliases.length > 0).map((cmd) => `\`${cmd.aliases[0]}\``);
if (categoryCommands.length > 0) {
embed.addFields([{ name: `${categoryNice}`, value: `${categoryCommands.join(' ')}` }]);
}
}
return message.util.reply({ embeds: [embed], components: row.components.length ? [row] : undefined });
}
private helpIndividual(message: BushMessage | BushSlashMessage, row: ActionRowBuilder<ButtonBuilder>, command: BushCommand) {
const embed = new EmbedBuilder().setColor(util.colors.default).setTitle(`${command.id} Command`);
let description = `${command.description ?? '*This command does not have a description.*'}`;
if (command.note) description += `\n\n${command.note}`;
embed.setDescription(description);
this.addCommandUsage(embed, command);
this.addCommandExamples(embed, command);
this.addCommandAliases(embed, command);
this.addCommandArguments(embed, command, message.author.isOwner(), message.author.isSuperUser());
this.addCommandRestrictions(embed, command);
// todo: permissions
const params = { embeds: [embed], components: row.components.length ? [row] : undefined };
return message.util.reply(params);
}
private addCommandUsage(embed: EmbedBuilder, command: BushCommand) {
if (command.usage?.length) {
embed.addFields([
{
name: `» Usage${command.usage.length > 1 ? 's' : ''}`,
value: command.usage.map((u) => `\`${u}\``).join('\n')
}
]);
}
}
private addCommandExamples(embed: EmbedBuilder, command: BushCommand) {
if (command.examples?.length) {
embed.addFields([
{
name: `» Example${command.examples.length > 1 ? 's' : ''}`,
value: command.examples.map((u) => `\`${u}\``).join('\n')
}
]);
}
}
private addCommandAliases(embed: EmbedBuilder, command: BushCommand) {
if (command.aliases?.length > 1)
embed.addFields([
{
name: '» Aliases',
value: `\`${command.aliases.join('` `')}\``
}
]);
}
private addCommandArguments(embed: EmbedBuilder, command: BushCommand, isOwner = false, isSuperUser = false) {
const format = (id: string, req: boolean) => `${req ? '<' : '['}${id}${req ? '>' : ']'}`;
const args = (command.argsInfo ?? []).filter((arg) => {
if (arg.ownerOnly && !isOwner) return false;
if (arg.superUserOnly && !isSuperUser) return false;
return true;
});
if (args.length) {
embed.addFields([
{
name: '» Arguments',
value: args
.map((a) => {
let ret = stripIndent`
\`${format(a.name, !!a.optional)}\`
⠀‣ **Desc**: ${a.description}
⠀‣ **Type**: ${typeof a.type !== 'function' ? a.type : '[no readable type]'}`;
if (a.flag?.length) ret += `\n⠀‣ **Flags**: ${a.flag.map((f) => `"${f}"`).join(', ')}`;
ret += `\n⠀‣ **Kind**: ${a.only ?? 'text & slash'}`;
if (a.only !== 'slash') ret += `\n⠀‣ **Match**: ${a.match}`;
if (a.only !== 'text') ret += `\n⠀‣ **Autocomplete**: ${a.autocomplete}`;
return ret;
})
.join('\n')
}
]);
}
}
private addCommandRestrictions(embed: EmbedBuilder, command: BushCommand) {
if (
command.ownerOnly ||
command.superUserOnly ||
command.hidden ||
command.channel ||
command.restrictedChannels?.length ||
command.restrictedGuilds?.length
) {
const restrictions: string[] = [];
if (command.ownerOnly) restrictions.push('__Developer Only__');
if (command.ownerOnly) restrictions.push('__Super User Only__');
if (command.hidden) restrictions.push('__Hidden__');
if (command.channel === 'dm') restrictions.push('__DM Only__');
if (command.channel === 'guild') restrictions.push('__Server Only__');
if (command.restrictedChannels?.length)
restrictions.push(`__Restricted Channels__: ${command.restrictedChannels.map((c) => `<#${c}>`).join(' ')}`);
if (command.restrictedGuilds?.length)
restrictions.push(
`__Restricted Servers__: ${command.restrictedGuilds
.map((g) => util.format.inlineCode(client.guilds.cache.find((g1) => g1.id === g)?.name ?? 'Unknown'))
.join(' ')}`
);
if (restrictions.length) embed.addFields([{ name: '» Restrictions', value: restrictions.join('\n') }]);
}
}
private addLinks(message: BushMessage | BushSlashMessage) {
const row = new ActionRowBuilder<ButtonBuilder>();
if (!client.config.isDevelopment && !client.guilds.cache.some((guild) => guild.ownerId === message.author.id)) {
row.addComponents([new ButtonBuilder({ style: ButtonStyle.Link, label: 'Invite Me', url: util.invite })]);
}
if (!client.guilds.cache.get(client.config.supportGuild.id)?.members.cache.has(message.author.id)) {
row.addComponents([
new ButtonBuilder({ style: ButtonStyle.Link, label: 'Support Server', url: client.config.supportGuild.invite })
]);
}
if (packageDotJSON?.repository)
row.addComponents([new ButtonBuilder({ style: ButtonStyle.Link, label: 'GitHub', url: packageDotJSON.repository })]);
else void message.channel?.send('Error importing package.json, please report this to my developer.');
return row;
}
public override autocomplete(interaction: AutocompleteInteraction) {
const aliases = this.handler.modules.map((module) => module.aliases).flat();
const fuzzy = new Fuse(aliases, {
threshold: 0.5,
isCaseSensitive: false,
findAllMatches: true
}).search(interaction.options.getFocused().toString());
const res = fuzzy.slice(0, fuzzy.length >= 25 ? 25 : undefined).map((v) => ({ name: v.item, value: v.item }));
const startingCommands = [
...this.handler.modules.filter((command) => !command.ownerOnly && !command.hidden && !command.pseudo).keys()
]
.slice(0, 25)
.map((v) => ({ name: v, value: v }));
void interaction.respond(res.length ? res : startingCommands);
}
}
type HelpArgs = { command: ArgType<'commandAlias'> | string; showHidden?: boolean };
|
