Add more comments

Author: BenjammingKirby

src/bot.ts

@@ -11,7 +11,7 @@ import { loadCommands, commandHandler } from "./handlers/CommandHandler";
                 activities: [{ type: "WATCHING", name: "Discord.JS channel" }],
                 status: "online",
             },
-            // For DMs, now on dms a partial channel is received
+            // For DMs, a partial channel object is received, in order to receive dms, CHANNEL partials must be activated  
             partials: ["CHANNEL"],
         }),
         commands: new Collection(),

src/commands/docs/djs.ts

@@ -25,7 +25,7 @@ const command: Command = {
             option
                 .setName("source")
                 .setDescription(
-                    "Select which branch/repository to get documentation off of"
+                    "Select which branch/repository to get documentation off of (Default: stable)"
                 )
                 .addChoices(supportedBranches)
                 .setRequired( false )
@@ -43,9 +43,11 @@ const command: Command = {
 
         const notFoundEmbed = doc.baseEmbed();
         notFoundEmbed.description = "Didn't find any results for that query";
+        // If a result wasn't found
         if ( !resultEmbed || resultEmbed.description === "" ) {
 
             const timeStampDate = new Date(notFoundEmbed.timestamp);
+            // Satisfies the method's MessageEmbedOption type 
             const embedObj = { ...notFoundEmbed, timestamp: timeStampDate };
 
             interaction.editReply({ embeds: [embedObj] }).catch(console.error);
@@ -54,9 +56,11 @@ const command: Command = {
 
         const timeStampDate = new Date(resultEmbed.timestamp);
         const embedObj = { ...resultEmbed, timestamp: timeStampDate };
-        
+
+        //! "checkEmbedLimits" does not support MessageEmbed objects due to the properties being null by default, use a raw embed object for this method
+        // Check if the embed exceeds any of the limits
         if (!checkEmbedLimits([resultEmbed])) {
-            // The final fields should be the View Source button
+            // The final field should be the View Source button
             embedObj.fields = [embedObj.fields?.at( -1 )];
         }
         interaction.editReply({ embeds: [embedObj] }).catch(console.error);

src/handlers/CommandHandler.ts

@@ -56,12 +56,14 @@ export function loadCommands(context: MyContext) {
  * @param command
  * @returns Whether to cancel the command
  */
+// * Note that as of writing, slash commands can override permissions 
 function commandPermissionCheck(
     interaction: CommandInteraction,
     command: Command
 ): boolean {
     const { client, user, channel } = interaction;
-    // If the channel is a dm, if it's a partial, channel.type wouldn't exist
+    // If the channel is a dm
+    // if it's a partial, channel.type wouldn't exist
     if (channel.type === "DM" || !channel) {
         if (command.guildOnly) {
             interaction
@@ -128,8 +130,9 @@ function commandCooldownCheck(
             }
             interaction
                 .editReply(
+                    //TODO revert to using custom logic to send remaining time as the discord timestamp formatting isn't very descriptive
                     `Please wait ${Formatters.time(
-                        Date.now() + existingCooldown,
+                        existingCooldown,
                         "R"
                     )} before using the command again`
                 )

src/interfaces.ts

@@ -22,6 +22,7 @@ export interface Command {
     | SlashCommandSubcommandsOnlyBuilder
     | SlashCommandOptionsType;
   cooldown?: number;
+  // * Note that as of writing, slash commands can override permissions
   botPermissions?: PermissionString[];
   authorPermissions?: PermissionString[];
   guildOnly?: boolean;