Merge pull request #319 from aternosorg/help

refactor help command, remove legacy commands

package.json

@@ -1,6 +1,6 @@
 {
   "name": "modbot",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "description": "Discord Bot for the Aternos Discord server",
   "main": "index.js",
   "scripts": {

src/Command.js

@@ -163,9 +163,9 @@ class Command {
             .addFields(
                 /** @type {any} */ { name: 'Usage', value: `\`${prefix}${cmd} ${this.usage}\``, inline: true},
                 /** @type {any} */ { name: 'Description', value: this.description, inline: true},
-                /** @type {any} */ { name: 'Required Permissions', value: this.userPerms.length !== 0 ? `\`${this.userPerms.join('`, `')}\`` : 'none' }
+                /** @type {any} */ { name: 'Required Permissions', value: this.userPerms.length !== 0 ? `\`${this.userPerms.join('`, `')}\`` : 'none', inline: true }
             )
-            .setColor(util.color.green)
+            .setColor(util.color.red)
             .setTimestamp();
         if (this.comment) {
             embed.addFields(
@@ -251,6 +251,15 @@ class Command {
             await message.reactions.removeAll();
         }
     }
+
+    /**
+     * get an overview of this command
+     * @return {string}
+     */
+    static getOverview() {
+        return `**${this.names.join(', ')}**\n`+
+            `${this.description}\n`;
+    }
 }
 
 module.exports = Command;

src/commands/utility/HelpCommand.js

@@ -0,0 +1,55 @@
+const Command = require('../../Command');
+const {MessageEmbed} = require('discord.js');
+const util = require('../../util');
+
+class HelpCommand extends Command {
+
+    static description = 'View command information';
+
+    static usage = '[<category|command>]';
+
+    static names = ['help'];
+
+    async execute() {
+
+        const commandManager = require('../../features/message/CommandManager');
+
+        const categories = commandManager.getCategories();
+        const commands = commandManager.getCommands();
+
+        if (!this.args.length) {
+            const embed = new MessageEmbed()
+                .setColor(util.color.red)
+                .setFooter(`View a command or category using ${this.prefix}help <category|command>`);
+            for (const [key, commands] of categories.entries()) {
+                if (commands.length === 0) continue;
+                embed.addField(util.toTitleCase(key), commands.map(c => c.names).flat().sort().join(', '));
+            }
+            return this.message.channel.send(embed);
+        }
+
+        const name = this.args.shift().toLowerCase();
+        const category = categories.get(name);
+        const command = commands.get(name);
+        if (!category && !command) return this.sendUsage();
+
+        if (category) {
+            let description = '';
+
+            for (const command of category) {
+                description += command.getOverview() + '\n';
+            }
+
+            return this.message.channel.send(new MessageEmbed()
+                .setTitle(`ModBot ${util.toTitleCase(name)} Commands:`)
+                .setColor(util.color.red)
+                .setDescription(description)
+                .setFooter(`View a command using ${this.prefix}help <command>`)
+            );
+        }
+
+        if (command) return this.message.channel.send(await command.getUsage(this.message, name, this.guildConfig));
+    }
+}
+
+module.exports = HelpCommand;

src/features/message/CommandManager.js

@@ -3,14 +3,21 @@ const defaultPrefix = require('../../../config.json').prefix;
 const Discord = require('discord.js');
 const util = require('../../util');
 const GuildConfig = require('../../GuildConfig');
+const {Collection} = Discord;
 const {APIErrors} = Discord.Constants;
-
 const monitor = require('../../Monitor').getInstance();
 
 class CommandManager {
+
     /**
-     * loaded commands
-     * @type {Object}
+     * command categories
+     * @type {module:"discord.js".Collection<String, Class<Command>[]>}
+     */
+    static #categories = new Collection();
+
+    /**
+     * loaded commands (name => class)
+     * @type {module:"discord.js".Collection<String, Class<Command>>}
      * @private
      */
     static #commands = this._loadCommands();
@@ -21,35 +28,53 @@ class CommandManager {
      * @private
      */
     static _loadCommands() {
-        const commands = {};
+        const commands = new Collection();
         for (const folder of fs.readdirSync(`${__dirname}/../../commands`)) {
+
+            const category = [];
+
             const dirPath = `${__dirname}/../../commands/${folder}`;
-            if (!fs.lstatSync(dirPath).isDirectory() || folder === 'legacy') continue;
+            if (!fs.lstatSync(dirPath).isDirectory()) continue;
             for (const file of fs.readdirSync(dirPath)) {
                 const path = `${dirPath}/${file}`;
                 if (!file.endsWith('.js') || !fs.lstatSync(path).isFile()) {
                     continue;
                 }
                 try {
                     const command = require(path);
+                    category.push(command);
                     for (const name of command.names) {
-                        if (commands[name]) {
+                        if (commands.has(name)) {
                             console.error(`Two command registered the name '${name}':`);
-                            console.error(`- ${commands[name].path}`);
+                            console.error(`- ${commands.get(name).path}`);
                             console.error(`- ${folder}/${file}`);
                         }
                         command.path = `${folder}/${file}`;
-                        commands[name] = command;
+                        commands.set(name, command);
                     }
                 } catch (e) {
                     monitor.error(`Failed to load command '${folder}/${file}'`, e);
                     console.error(`Failed to load command '${folder}/${file}'`, e);
                 }
             }
+
+            this.#categories.set(folder, category);
         }
         return commands;
     }
 
+    /**
+     * get command categories
+     * @return {module:"discord.js".Collection<String, Class<Command>[]>}
+     */
+    static getCategories() {
+        return this.#categories;
+    }
+
+    /**
+     * get all commands (name => class)
+     * @return {module:"discord.js".Collection<String, Class<Command>>}
+     */
     static getCommands() {
         return this.#commands;
     }
@@ -64,7 +89,7 @@ class CommandManager {
      */
     static async event(options, message) {
         const {isCommand, name, prefix} = await this.getCommandName(message);
-        const Command = this.#commands[name];
+        const Command = this.#commands.get(name);
         if (!isCommand || Command === undefined) return;
 
         try {
@@ -129,7 +154,7 @@ class CommandManager {
     static async isCommand(message) {
         const {isCommand, name} = await this.getCommandName(message);
         if (!isCommand) return false;
-        return this.#commands[name] !== undefined;
+        return this.#commands.has(name);
     }
 }