adds commandTable.ts

src/commands/index.ts

@@ -25,6 +25,7 @@ import birthday from './utils/birthday/birthday';
 import count from './utils/count';
 import vatsim from './utils/vatsim/vatsim';
 import help from './utils/help';
+import commandTable from './moderation/commandTable';
 
 const commandArray: SlashCommand[] = [
     ping,
@@ -53,6 +54,7 @@ const commandArray: SlashCommand[] = [
     count,
     vatsim,
     help,
+    commandTable,
 ];
 
 export default commandArray;

src/commands/moderation/commandTable.ts

@@ -0,0 +1,92 @@
+import { ApplicationCommandOptionType, ApplicationCommandType, CommandInteraction } from 'discord.js';
+import fs from 'fs';
+import { slashCommand, slashCommandStructure, Logger } from '../../lib';
+
+const data = slashCommandStructure({
+    name: 'generate_command_table',
+    description: 'Generates the command table.',
+    type: ApplicationCommandType.ChatInput,
+});
+
+export default slashCommand(data, async ({ interaction }: { interaction: CommandInteraction }) => {
+    try {
+        // Fetch all commands from the API based on the environment
+        let commands;
+
+        if (process.env.NODE_ENV === 'production') {
+            commands = await interaction.client.application?.commands.fetch();
+        } else {
+            commands = await interaction.guild?.commands.fetch();
+        }
+
+        // Check if the commands were fetched successfully
+        if (!commands) {
+            return interaction.reply({
+                content: 'An error occurred while fetching commands.',
+                ephemeral: true,
+            });
+        }
+
+        // Convert the iterable of commands into an array
+        const commandArray = Array.from(commands.values());
+
+        // Sort the commands alphabetically by name
+        const sortedCommands = commandArray.sort((a, b) => a.name.localeCompare(b.name));
+
+        // Build the Markdown table
+        let table = '## Bot Commands\n\n| Command | Description | Subcommand and Groups |\n| --- | --- | --- |\n';
+
+        for (const command of sortedCommands) {
+            // eslint-disable-next-line prefer-const
+            let { name, description, type } = command;
+
+            const subcommandList = command.options?.filter((option) => option.type === ApplicationCommandOptionType.Subcommand || option.type === ApplicationCommandOptionType.SubcommandGroup);
+
+            let subcommandDescription = '';
+
+            if (subcommandList && subcommandList.length > 0) {
+                subcommandDescription = subcommandList
+                    .map((subcommand) => {
+                        if (subcommand.type === ApplicationCommandOptionType.Subcommand) {
+                            return subcommand.name;
+                        }
+                        if (subcommand.type === ApplicationCommandOptionType.SubcommandGroup) {
+                            const groupSubcommands = subcommand.options?.filter((sub) => sub.type === ApplicationCommandOptionType.Subcommand);
+                            if (groupSubcommands && groupSubcommands.length > 0) {
+                                return `${subcommand.name} [${groupSubcommands
+                                    .map((sub) => sub.name)
+                                    .join(', ')}]`;
+                            }
+                            return `${subcommand.name} [None]`;
+                        }
+                        return '';
+                    })
+                    .join(', ');
+            }
+
+            // Denote context-specific commands in the description
+            if (type === ApplicationCommandType.User || type === ApplicationCommandType.Message) {
+                description += `(Context Command - ${type === ApplicationCommandType.User ? 'User' : 'Message'})`;
+            }
+
+            // Append subcommands to the Subcommands column
+            table += `| ${name} | ${description} | ${subcommandDescription} |\n`;
+        }
+
+        // Save the Markdown table to a file
+        const filePath = 'commands_table.md';
+        fs.writeFileSync(filePath, table);
+
+        return interaction.reply({
+            content: `Markdown table has been saved to ${filePath}`,
+            ephemeral: true,
+        });
+    } catch (error) {
+        Logger.error(error);
+        return interaction.reply({
+            content: 'An error occurred while generating the Markdown file.',
+            ephemeral: true,
+        });
+        // Handle errors appropriately
+    }
+});