Simplified command API for improved usability and reduced complexity.

KrozT · KrozT · commit 66dee0ad1132 · 2023-06-14T16:28:24.000-04:00
diff --git a/README.md b/README.md
@@ -87,6 +87,7 @@ A simple Discord bot integrating OpenAI libraries for ChatGPT and DALL-E, capabl
         <li><a href="#embeds">Embeds</a></li>
       </ul>
     </li>
+    <li><a href="#commands-api">Commands API</a></li>
     <li><a href="#roadmap">Roadmap</a></li>
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
@@ -187,7 +188,7 @@ just add the bot to your server and enjoy.
 |-------------|-------------------------------------------|----------|-----------|---------------------------------|-------------------------------------|
 | `question`  | `/chat`                                   | `true`   | None      | None                            | The question to ask the bot         |
 | `prompt`    | `/image`                                  | `true`   | None      | None                            | The text to generate the image from |
-| `quantity`  | `/image`                                  | `false`  | `100`     | `1` to `10`                     | Quantity of images to generate      |
+| `quantity`  | `/image`                                  | `false`  | `1`       | `1` to `10`                     | Quantity of images to generate      |
 | `size`      | `/image`                                  | `false`  | `256x256` | `256x256` `512x512` `1024x1024` | Size of the image to generate       |
 | `amount`    | `/clear`                                  | `false`  | `100`     | `1` to `100`                    | Amount of messages to clear         |
 | `ephimeral` | `/ping` `/about` `/help` `/chat` `/image` | `false`  | `false`   | `true` `false`                  | Hide the response from other users  |
@@ -207,6 +208,33 @@ The bot uses a variety of visual embeds code located in the footer of each messa
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+## Commands API
+
+You can add new commands to the project by following these steps:
+
+1. Create a new file in the `src/bot/commands` folder with the name of the command you want to add (e.g. `testCommand.ts`).
+2. Write a class that extends the `Command` and implements all the methods.
+3. Your command will be automatically added to the bot.
+
+Command example:
+```ts
+import { Command } from '@/bot/models/command';
+import { Client, CommandInteraction } from 'discord.js';
+
+export class TestCommand extends Command {
+    public configure(): void {
+        this.setName('test');
+        this.setDescription('Test command');
+        this.addEphemeralOption(); // Add the ephemeral option to the command
+    }
+
+    protected async execute(client: Client, interaction: CommandInteraction): Promise<void> {
+        await interaction.reply({content: 'Test command executed', ephemeral: this.ephermeral});
+    }
+}
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 
 <!-- ROADMAP -->
diff --git a/src/bot/commands/aboutCommand.ts b/src/bot/commands/aboutCommand.ts
@@ -4,25 +4,12 @@ import { SystemEmbed } from '@/bot/embeds/systemEmbed';
 import { EmbedAuthor, EmbedType } from '@/bot/models/embed';
 
 export class AboutCommand extends Command {
-  constructor() {
-    /**
-     * Call the parent constructor
-     */
-    super();
-
-    /**
-     * Set command data for Discord API
-     */
+  public configure(): void {
     this.setName('about');
     this.setDescription('About the bot');
     this.addEphemeralOption(); // Add the ephemeral option to the command
   }
 
-  /**
-   * Execute the command with the given interaction
-   * @param client
-   * @param interaction
-   */
   protected async execute(client: Client, interaction: CommandInteraction): Promise<void> {
     /**
      * Defer the reply to the interaction
diff --git a/src/bot/commands/chatCommand.ts b/src/bot/commands/chatCommand.ts
@@ -7,15 +7,7 @@ import { ChatEmbed } from '@/bot/embeds/chatEmbed';
 import { SystemEmbed } from '@/bot/embeds/systemEmbed';
 
 export class ChatCommand extends Command {
-  constructor() {
-    /**
-     * Call the parent constructor
-     */
-    super();
-
-    /**
-     * Set command data for Discord API
-     */
+  public configure(): void {
     this.setName('chat');
     this.setDescription('Chat with the bot');
     this.addStringOption((option) => option
@@ -79,33 +71,33 @@ export class ChatCommand extends Command {
     chatHistory.push(currentQuestion);
 
     /**
-     * Embeds array to store the embeds
-     */
-    const embeds: EmbedBuilder[] = [];
-
-    /**
-     * Create the question embed and add it to the embeds array
+     * Embeds array with initial embed for the question
      */
-    const questionEmbed = new ChatEmbed(client, interaction, EmbedAuthor.User, question as string);
-    embeds.push(questionEmbed);
+    const embeds: EmbedBuilder[] = [
+      new ChatEmbed(client, interaction, EmbedAuthor.User, question as string),
+    ];
 
     /**
      * Get the answer from the AI
      */
     await ai?.chatCompletion(chatHistory)
       .then((response) => {
-        const responseEmbed = new ChatEmbed(client, interaction, EmbedAuthor.Bot, response.content); // Create a new text embed with the response
-        embeds.push(responseEmbed); // Add the response embed to the embeds array
+        /**
+         * Add the response to the embeds array
+         */
+        embeds.push(new ChatEmbed(client, interaction, EmbedAuthor.Bot, response.content));
       }) // Get the content from the response
       .catch((error: Error) => {
-        const errorEmbed = new SystemEmbed(
+        /**
+         * Add the error to the embeds array
+         */
+        embeds.push(new SystemEmbed(
           client,
           interaction,
           EmbedAuthor.Bot,
           EmbedType.Error,
           error.message,
-        ); // Create a new error embed with the error message
-        embeds.push(errorEmbed); // Add the error embed to the embeds array
+        ));
       });
 
     /**
diff --git a/src/bot/commands/clearCommand.ts b/src/bot/commands/clearCommand.ts
@@ -4,15 +4,7 @@ import { SystemEmbed } from '@/bot/embeds/systemEmbed';
 import { EmbedAuthor, EmbedType } from '@/bot/models/embed';
 
 export class ClearCommand extends Command {
-  constructor() {
-    /**
-     * Call the parent constructor
-     */
-    super();
-
-    /**
-     * Set command data for Discord API
-     */
+  public configure(): void {
     this.setName('clear');
     this.setDescription('Clear the chat history with the bot');
     this.addNumberOption((option) => option
diff --git a/src/bot/commands/helpCommand.ts b/src/bot/commands/helpCommand.ts
@@ -4,15 +4,7 @@ import { SystemEmbed } from '@/bot/embeds/systemEmbed';
 import { EmbedAuthor, EmbedType } from '@/bot/models/embed';
 
 export class HelpCommand extends Command {
-  constructor() {
-    /**
-     * Call the parent constructor
-     */
-    super();
-
-    /**
-     * Set command data for Discord API
-     */
+  public configure(): void {
     this.setName('help');
     this.setDescription('Get all the commands available');
     this.addEphemeralOption(); // Add the ephemeral option to the command
diff --git a/src/bot/commands/imageCommand.ts b/src/bot/commands/imageCommand.ts
@@ -10,15 +10,7 @@ import { AI } from '@/models/ai';
 import { ChatEmbed } from '@/bot/embeds/chatEmbed';
 
 export class ImageCommand extends Command {
-  constructor() {
-    /**
-     * Call the parent constructor
-     */
-    super();
-
-    /**
-     * Set command data for Discord API
-     */
+  public configure(): void {
     this.setName('image');
     this.setDescription('Generate an image with the prompt provided');
     this.addStringOption((option) => option
diff --git a/src/bot/commands/pingCommand.ts b/src/bot/commands/pingCommand.ts
@@ -4,15 +4,7 @@ import { SystemEmbed } from '@/bot/embeds/systemEmbed';
 import { EmbedAuthor, EmbedType } from '@/bot/models/embed';
 
 export class PingCommand extends Command {
-  constructor() {
-    /**
-     * Call the parent constructor
-     */
-    super();
-
-    /**
-     * Set command data for Discord API
-     */
+  public configure(): void {
     this.setName('ping');
     this.setDescription('Ping the bot to check if it is online');
     this.addEphemeralOption(); // Add the ephemeral option to the command
diff --git a/src/bot/index.ts b/src/bot/index.ts
@@ -99,6 +99,7 @@ export class Bot implements Runnable {
           const ImportedCommand = module[exportedKey];
           if (typeof ImportedCommand === 'function' && ImportedCommand.prototype instanceof Command) {
             const commandInstance = new ImportedCommand(); // Create command instance
+            commandInstance.configure(); // Configure command
             loadedCommands.push(commandInstance); // Add command to the container
           }
         });
diff --git a/src/bot/models/command.ts b/src/bot/models/command.ts
@@ -26,6 +26,12 @@ export abstract class Command extends SlashCommandBuilder {
    */
   protected _interactionResolver!: CommandInteractionOptionResolver;
 
+  /**
+   * Configure the command without using the constructor on child classes
+   * @public
+   */
+  public abstract configure(): void;
+
   /**
    * Add Ephemeral option to command
    * @protected

Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,7 @@ export class Bot implements Runnable {`
`99`	`99`	`const ImportedCommand = module[exportedKey];`
`100`	`100`	`if (typeof ImportedCommand === 'function' && ImportedCommand.prototype instanceof Command) {`
`101`	`101`	`const commandInstance = new ImportedCommand(); // Create command instance`
	`102`	`+ commandInstance.configure(); // Configure command`
`102`	`103`	`loadedCommands.push(commandInstance); // Add command to the container`
`103`	`104`	`}`
`104`	`105`	`});`