Add more comments

Author: BenjammingKirby

src/commands/docs/djs.ts

@@ -4,7 +4,7 @@ import Doc, { sources } from "discord.js-docs";
 import { checkEmbedLimits } from "../../utils/EmbedUtils";
 import { deleteButton } from "../../utils/CommandUtils";
 import { MessageActionRow, MessageSelectMenu } from "discord.js";
-import { APIEmbed } from "discord-api-types";
+import type { APIEmbed } from "discord-api-types";
 
 const supportedBranches = Object.keys(sources).map((branch) => [capitalize(branch), branch] as [string, string]);
 
@@ -55,6 +55,8 @@ const command: Command = {
             await interaction.reply({ embeds: [embedObj], ephemeral: true }).catch(console.error);
             return;
         } else if (Array.isArray(result)) {
+            // If there are multiple results, send a select menu from which the user can choose which one to send
+
             const selectMenuRow = new MessageActionRow().addComponents(
                 new MessageSelectMenu()
                     .setCustomId(`djsselect/${source}/${searchPrivate}/${interaction.user.id}`)
@@ -92,15 +94,18 @@ function capitalize(str: string) {
         .join("-");
 }
 
+// Export to reuse on the select menu handler
 export function searchDJSDoc(doc: Doc, query: string, searchPrivate?: boolean) {
     const options = { excludePrivateElements: !searchPrivate };
 
     const singleElement = doc.get(...query.split(/\.|#/));
+    // Return embed for the single element, the exact match
     if (singleElement) return singleElement.embed(options);
 
     const searchResults = doc.search(query, options);
     if (!searchResults) return null;
     return searchResults.map((res) => {
+        // Labels and values have a limit of 100 characters
         const description = res.description.length >= 99 ? res.description.slice(0, 96) + "..." : res.description;
         return {
             label: res.formattedName,
@@ -110,6 +115,11 @@ export function searchDJSDoc(doc: Doc, query: string, searchPrivate?: boolean) {
         };
     });
 }
+/**
+ * Return the unicode version of the regional emojis
+ * @param regionalEmoji
+ * @returns The unicode version of the emoji
+ */
 function resolveRegionalEmoji(regionalEmoji: string) {
     const character = regionalEmoji.match(/:regional_indicator_(.):/)?.[1];
     if (!character) return null;

src/commands/docs/mdn.ts

@@ -58,6 +58,7 @@ const command: Command = {
 
             return;
         } else {
+            // If there are multiple results, send a select menu from which the user can choose which one to send
             const results = search.map((path) => `**• [${path.replace(/_|-/g, " ")}](${MDN_BASE_URL}${path})**`);
 
             embed.setDescription(results.join("\n"));
@@ -84,6 +85,7 @@ const command: Command = {
     },
 };
 
+// Export to reuse on the select menu handler
 export async function getSingleMDNSearchResults(searchQuery: string) {
     const res = await fetch(`${MDN_BASE_URL + searchQuery}/index.json`);
     const doc: MdnDoc = (await res.json()).doc;

src/handlers/CommandHandler.ts

@@ -1,18 +1,14 @@
-import glob from "glob";
 import type { Command, MyContext } from "../interfaces";
-import {
-    ButtonInteraction,
-    CommandInteraction,
-    Interaction,
-    Message,
-    MessageActionRow,
-    SelectMenuInteraction,
-} from "discord.js";
+import type { ButtonInteraction, CommandInteraction, Interaction, Message, SelectMenuInteraction } from "discord.js";
+import type { APIEmbed } from "discord-api-types";
+
 import { commandCooldownCheck, commandPermissionCheck, deleteButton } from "../utils/CommandUtils";
 import { getSingleMDNSearchResults } from "../commands/docs/mdn";
 import { searchDJSDoc } from "../commands/docs/djs";
+import { MessageActionRow } from "discord.js";
+
+import glob from "glob";
 import Doc from "discord.js-docs";
-import { APIEmbed } from "discord-api-types";
 
 export async function interactionCreateHandler(context: MyContext, interaction: Interaction<"cached">) {
     if (interaction.isCommand()) {
@@ -69,32 +65,48 @@ async function commandInteractionHandler(context: MyContext, interaction: Comman
 }
 async function selectMenuInteractionHandler(context: MyContext, interaction: SelectMenuInteraction) {
     const CommandName = interaction.customId.split("/")[0];
-    if (!CommandName) interaction.reply({ content: "Unknown menu", ephemeral: true }).catch(console.error);
+    if (!CommandName)
+        switch (CommandName) {
+            case "mdnselect": {
+                const Initiator = interaction.customId.split("/")[1];
+                const deleteButtonRow = new MessageActionRow().addComponents([deleteButton(Initiator)]);
+                const selectedValue = interaction.values[0];
+                const resultEmbed = await getSingleMDNSearchResults(selectedValue);
 
-    if (CommandName === "mdnselect") {
-        const Initiator = interaction.customId.split("/")[1];
-        const deleteButtonRow = new MessageActionRow().addComponents([deleteButton(Initiator)]);
-        const selectedValue = interaction.values[0];
-        const resultEmbed = await getSingleMDNSearchResults(selectedValue);
+                // Remove the menu and update the ephemeral message
+                await interaction
+                    .update({ content: "Sent documentation for " + selectedValue, components: [] })
+                    .catch(console.error);
+                // Send documentation
+                await interaction
+                    .followUp({ embeds: [resultEmbed], components: [deleteButtonRow] })
+                    .catch(console.error);
+                break;
+            }
 
-        await interaction
-            .update({ content: "Sent documentation for " + selectedValue, components: [] })
-            .catch(console.error);
-        await interaction.followUp({ embeds: [resultEmbed], components: [deleteButtonRow] }).catch(console.error);
-    } else if (CommandName === "djsselect") {
-        const selectedValue = interaction.values[0];
-        const [, source, searchPrivate, Initiator] = interaction.customId.split("/");
-        const deleteButtonRow = new MessageActionRow().addComponents([deleteButton(Initiator)]);
+            case "djsselect": {
+                const selectedValue = interaction.values[0];
+                const [, source, searchPrivate, Initiator] = interaction.customId.split("/");
+                const deleteButtonRow = new MessageActionRow().addComponents([deleteButton(Initiator)]);
 
-        const doc = await Doc.fetch(source, { force: true });
+                const doc = await Doc.fetch(source, { force: true });
 
-        const resultEmbed = searchDJSDoc(doc, selectedValue, searchPrivate === "true") as APIEmbed;
+                const resultEmbed = searchDJSDoc(doc, selectedValue, searchPrivate === "true") as APIEmbed;
 
-        await interaction
-            .update({ content: "Sent documentation for " + selectedValue, components: [] })
-            .catch(console.error);
-        await interaction.followUp({ embeds: [resultEmbed], components: [deleteButtonRow] }).catch(console.error);
-    }
+                // Remove the menu and update the ephemeral message
+                await interaction
+                    .update({ content: "Sent documentation for " + selectedValue, components: [] })
+                    .catch(console.error);
+                // Send documentation
+                await interaction
+                    .followUp({ embeds: [resultEmbed], components: [deleteButtonRow] })
+                    .catch(console.error);
+                break;
+            }
+            default: {
+                interaction.reply({ content: "Unknown menu", ephemeral: true }).catch(console.error);
+            }
+        }
 }
 async function buttonInteractionHandler(context: MyContext, interaction: ButtonInteraction<"cached">) {
     // The delete button
@@ -112,4 +124,5 @@ async function buttonInteractionHandler(context: MyContext, interaction: ButtonI
                 .catch(console.error);
     }
 }
-// async function autocompleteInteractionHandler(context: MyContext, interaction: AutocompleteInteraction) {}
+// TODO add autocomplete
+// async function autocompleteInteractionHandler(context: MyContext, interaction: AutocompleteInteraction) {}s