fix(help): Check for unset commands, autogen help message

Author: Gerrit0

src/modules/etc.ts

@@ -21,14 +21,17 @@ export class EtcModule extends Module {
 		await msg.channel.send('pong. :ping_pong:');
 	}
 
-	@command({ description: 'Sends a link to <https://dontasktoask.com>' })
+	@command({
+		description:
+			'Sends a link to [dontasktoask.com](https://dontasktoask.com)',
+	})
 	async ask(msg: Message) {
 		await msg.channel.send('https://dontasktoask.com/');
 	}
 
 	@command({
 		description:
-			'Sends a link to <https://github.com/facebook/create-react-app/pull/8177#issue-353062710>',
+			'Sends a link to [a pull request removing React.FC](https://github.com/facebook/create-react-app/pull/8177#issue-353062710)',
 	})
 	async reactfc(msg: Message) {
 		await msg.channel.send(

src/modules/help.ts

@@ -4,8 +4,47 @@ import {
 	Module,
 	CommonInhibitors,
 	optional,
+	Command,
 } from 'cookiecord';
 import { Message, MessageEmbed } from 'discord.js';
+import { sendWithMessageOwnership } from '../util/send';
+
+function getCategoryHelp(cat: string, commands: Set<Command>) {
+	const out: string[] = [];
+
+	for (const cmd of commands) {
+		if (
+			cmd.description &&
+			splitCategoryDescription(cmd.description)[0] === cat
+		) {
+			out.push(
+				`\`${cmd.triggers[0]}\` ► ${cmd.description.substr(
+					cat.length + 2,
+				)}`,
+			);
+		}
+	}
+
+	return out.join('\n');
+}
+
+function splitCategoryDescription(description: string): [string, string] {
+	const split = description.split(': ', 2);
+	if (split.length !== 2) {
+		return ['Misc', description];
+	}
+	return split as [string, string];
+}
+
+function getCommandCategories(commands: Set<Command>) {
+	const categories = new Set<string>();
+
+	for (const cmd of commands) {
+		categories.add(splitCategoryDescription(cmd.description ?? '')[0]);
+	}
+
+	return [...categories].sort((a, b) => a.localeCompare(b));
+}
 
 export class HelpModule extends Module {
 	constructor(client: CookiecordClient) {
@@ -21,47 +60,58 @@ export class HelpModule extends Module {
 		if (!msg.guild) return;
 
 		if (!cmdTrigger) {
-			let embed = new MessageEmbed()
+			const embed = new MessageEmbed()
 				.setAuthor(
 					msg.guild.name,
 					msg.guild.iconURL({ dynamic: true }) || undefined,
 				)
 				.setTitle('Bot Usage')
 				.setDescription(
 					`Hello ${msg.author.username}! Here is a list of all commands in me! To get detailed description on any specific command, do \`help <command>\``,
-				)
-				.addField(
-					`**Misc Commands:**`,
-					`\`help\` ► View a list of all commands!\n\`ping\` ► View the latency of the bot\n\`ask\` ► Sends a message with a link for [dontasktoask.com](https://dontasktoask.com)\n\`reactfc\` ► Sends a message with a link to a [pull request removing React.FC](https://github.com/facebook/create-react-app/pull/8177#issue-353062710)\n\`playground\` ► Just enter your code and get a link with TS playground!`,
-				)
-				.addField(
-					`**Help Channel Commands:**`,
-					`\`done\` ► Close a __ongoing__ help channel opened by you!`,
-				)
-				.addField(
-					`**Reputation Commands**`,
-					`\`rep\` ► Did somebody help you? Give them a reputation point!\n\`history\` ► Check the reputation history of a user!\n\`leaderboard\` ► See the reputation leaderboard!`,
-				)
+				);
+
+			for (const cat of getCommandCategories(
+				this.client.commandManager.cmds,
+			)) {
+				embed.addField(
+					`**${cat} Commands:**`,
+					getCategoryHelp(cat, this.client.commandManager.cmds),
+				);
+			}
+
+			embed
 				.setFooter(
 					this.client.user?.username,
 					this.client.user?.displayAvatarURL(),
 				)
 				.setTimestamp();
 
-			return await msg.channel.send(embed);
-		} else {
-			const cmd = this.client.commandManager.getByTrigger(cmdTrigger);
-			await msg.channel.send(
-				`Usage: \`${cmd?.triggers.join('|')}${
-					cmd?.args.length ? ' ' : ''
-				}${cmd?.args.map(arg =>
-					arg.optional ? `[${arg.type.name}]` : `<${arg.type.name}>`,
-				)}\`${
-					cmd?.description
-						? `\nDescription: *${cmd?.description}*`
-						: ''
-				}`,
+			return await sendWithMessageOwnership(msg, { embed });
+		}
+
+		const cmd = this.client.commandManager.getByTrigger(cmdTrigger);
+		if (!cmd || !cmd.description) {
+			await sendWithMessageOwnership(
+				msg,
+				`:x: Command "${cmdTrigger}" not found`,
+			);
+			return;
+		}
+
+		const embed = new MessageEmbed().setTitle(`\`${cmdTrigger}\` Usage`);
+		// Get rid of duplicates, this can happen if someone adds the method name as an alias
+		const triggers = new Set(cmd.triggers);
+		if (triggers.size > 1) {
+			embed.addField(
+				'Aliases',
+				Array.from(triggers, t => `\`${t}\``).join(', '),
 			);
 		}
+		embed.addField(
+			'Description',
+			`*${splitCategoryDescription(cmd.description ?? '')[1]}*`,
+		);
+
+		await sendWithMessageOwnership(msg, { embed });
 	}
 }

src/modules/helpchan.ts

@@ -199,8 +199,8 @@ export class HelpChanModule extends Module {
 	}
 
 	@command({
-		aliases: ['resolve', 'done', 'close'],
-		description: 'Marks this channel as resolved',
+		aliases: ['close', 'resolve', 'done'],
+		description: 'Help Channel: Marks this channel as resolved',
 	})
 	async resolved(msg: Message) {
 		if (
@@ -329,7 +329,11 @@ export class HelpChanModule extends Module {
 		await helpUser.save();
 	}
 
-	@command({ inhibitors: [CommonInhibitors.guildsOnly] })
+	@command({
+		inhibitors: [CommonInhibitors.guildsOnly],
+		aliases: ['claimed'],
+		description: 'Help Channel: Check if a user has an open help channel',
+	})
 	async cooldown(msg: Message, @optional member?: GuildMember) {
 		const guildTarget = await msg.guild!.members.fetch(
 			member ?? msg.author,
@@ -360,7 +364,10 @@ export class HelpChanModule extends Module {
 		);
 	}
 
-	@command({ inhibitors: [isTrustedMember] })
+	@command({
+		inhibitors: [isTrustedMember],
+		description: "Help Channel: Claim a help channel for a user's question",
+	})
 	async claim(msg: Message, member: GuildMember) {
 		const helpUser = await HelpUser.findOne({
 			userId: member.id,

src/modules/rep.ts

@@ -75,7 +75,8 @@ export class RepModule extends Module {
 	}
 
 	@command({
-		description: 'See how many reputation points you have left to send',
+		description:
+			'Reputation: See how many reputation points you have left to send',
 	})
 	async remaining(msg: Message) {
 		const USED = '✅';
@@ -91,7 +92,9 @@ export class RepModule extends Module {
 		);
 	}
 
-	@command({ description: 'Give a different user some reputation points' })
+	@command({
+		description: 'Reputation: Give a different user some reputation points',
+	})
 	async rep(msg: Message, targetMember: GuildMember) {
 		if (targetMember.id === msg.member?.id)
 			return msg.channel.send(`:x: you cannot send rep to yourself`);
@@ -118,7 +121,7 @@ export class RepModule extends Module {
 
 	@command({
 		aliases: ['history'],
-		description: "View a user's reputation history",
+		description: "Reputation: View a user's reputation history",
 	})
 	async getrep(msg: Message, @optional user?: User) {
 		if (!user) user = msg.author;
@@ -153,8 +156,8 @@ export class RepModule extends Module {
 	}
 
 	@command({
-		aliases: ['lb'],
-		description: 'See who has the most reputation',
+		aliases: ['leaderboard', 'lb'],
+		description: 'Reputation: See who has the most reputation',
 	})
 	async leaderboard(msg: Message) {
 		const topEmojis = [':first_place:', ':second_place:', ':third_place:'];

src/modules/twoslash.ts

@@ -23,7 +23,7 @@ export class TwoslashModule extends Module {
 	@command({
 		single: true,
 		description:
-			'Search for a symbol and get the type of it in the latest codeblock',
+			'Twoslash: Search for a symbol and get the type of it in the latest codeblock',
 	})
 	async ts(msg: Message, content: string) {
 		const match = /^[_$a-zA-Z][_$0-9a-zA-Z]*/.exec(content);
@@ -66,7 +66,7 @@ export class TwoslashModule extends Module {
 
 	@command({
 		description:
-			'Run twoslash on the latest codeblock, returning compiler errors and queries',
+			'Twoslash: Run twoslash on the latest codeblock, returning compiler errors and queries',
 	})
 	async twoslash(msg: Message) {
 		const code = await findCodeFromChannel(msg.channel as TextChannel);