command aliases

package.json

@@ -33,7 +33,9 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "dev": "pnpm -C playground run dev",
+    "dev": "npm-run-all --parallel --print-label --race dev-*",
+    "dev-playground": "pnpm -C playground run dev",
+    "dev-build": "pnpm build -- --watch",
     "build": "tsup-node",
     "typecheck": "tsc --noEmit",
     "test": "jest --colors",
@@ -104,7 +106,12 @@
   },
   "jest": {
     "transform": {
-      "^.+\\.tsx?$": "esbuild-jest"
+      "^.+\\.tsx?$": [
+        "esbuild-jest",
+        {
+          "sourcemap": true
+        }
+      ]
     },
     "verbose": true
   },

playground/src/commands/reverse.ts

@@ -3,9 +3,13 @@ import type { Gatekeeper } from "@itsmapleleaf/gatekeeper"
 export default function defineCommands(gatekeeper: Gatekeeper) {
   gatekeeper.addMessageCommand({
     name: "reverse message content",
+    aliases: ["rev"],
     run(context) {
       context.reply(() =>
-        context.targetMessage.content.split("").reverse().join(""),
+        (context.targetMessage.content || "no message content")
+          .split("")
+          .reverse()
+          .join(""),
       )
     },
   })

playground/src/commands/spongebob.ts

@@ -1,7 +1,7 @@
 import type { Gatekeeper } from "@itsmapleleaf/gatekeeper"
 
 function spongebobify(text: string): string {
-  return [...text]
+  return [...(text || "no message content")]
     .map((char, index) =>
       index % 2 === 0 ? char.toLocaleLowerCase() : char.toLocaleUpperCase(),
     )
@@ -11,6 +11,7 @@ function spongebobify(text: string): string {
 export default function defineCommands(gatekeeper: Gatekeeper) {
   gatekeeper.addMessageCommand({
     name: "spongebob",
+    aliases: ["sb"],
     run(context) {
       context.reply(() => spongebobify(context.targetMessage.content))
     },

src/core/command/message-command.ts

@@ -14,6 +14,10 @@ export type MessageCommandConfig = {
    * The name of the command. This shows up in the context menu for messages.
    */
   name: string
+
+  /** Aliases: alternate names to call this command with */
+  aliases?: string[]
+
   /**
    * The function to call when the command is ran.
    */
@@ -26,43 +30,47 @@ export type MessageCommandInteractionContext = InteractionContext & {
   targetMessage: Message
 }
 
-export function defineMessageCommand(config: MessageCommandConfig): Command {
-  return createCommand({
-    name: config.name,
+export function createMessageCommands(config: MessageCommandConfig): Command[] {
+  const names = [config.name, ...(config.aliases || [])]
 
-    matchesExisting: (appCommand) => {
-      return appCommand.name === config.name && appCommand.type === "MESSAGE"
-    },
+  return names.map((name) =>
+    createCommand({
+      name,
 
-    register: async (commandManager) => {
-      await commandManager.create({
-        type: "MESSAGE",
-        name: config.name,
-      })
-    },
+      matchesExisting: (appCommand) => {
+        return appCommand.name === name && appCommand.type === "MESSAGE"
+      },
 
-    matchesInteraction: (interaction) =>
-      interaction.isContextMenu() &&
-      interaction.targetType === "MESSAGE" &&
-      interaction.commandName === config.name,
+      register: async (commandManager) => {
+        await commandManager.create({
+          type: "MESSAGE",
+          name,
+        })
+      },
 
-    run: async (interaction, command) => {
-      const isMessageInteraction =
+      matchesInteraction: (interaction) =>
         interaction.isContextMenu() &&
-        interaction.channel &&
-        interaction.targetType === "MESSAGE"
+        interaction.targetType === "MESSAGE" &&
+        interaction.commandName === name,
+
+      run: async (interaction, command) => {
+        const isMessageInteraction =
+          interaction.isContextMenu() &&
+          interaction.channel &&
+          interaction.targetType === "MESSAGE"
 
-      if (!isMessageInteraction)
-        raise("Expected a context menu message interaction")
+        if (!isMessageInteraction)
+          raise("Expected a context menu message interaction")
 
-      const targetMessage = await interaction.channel.messages.fetch(
-        interaction.targetId,
-      )
+        const targetMessage = await interaction.channel.messages.fetch(
+          interaction.targetId,
+        )
 
-      await config.run({
-        ...createInteractionContext({ interaction, command }),
-        targetMessage,
-      })
-    },
-  })
+        await config.run({
+          ...createInteractionContext({ interaction, command }),
+          targetMessage,
+        })
+      },
+    }),
+  )
 }

src/core/command/slash-command.ts

@@ -28,6 +28,9 @@ export type SlashCommandConfig<
    */
   name: string
 
+  /** Aliases: alternate names to call this command with */
+  aliases?: string[]
+
   /**
    * The description of the command.
    * Shows up when showing a list of the bot's commands
@@ -225,82 +228,86 @@ function sortChannelTypes(
   )
 }
 
-export function defineSlashCommand<Options extends SlashCommandOptionConfigMap>(
-  config: SlashCommandConfig<Options>,
-): Command {
-  const options: ApplicationCommandOptionData[] = Object.entries(
-    config.options ?? {},
-  ).map(([name, option]) => ({
-    name,
-    description: option.description,
-    type: option.type,
-
-    // discord always returns a boolean, even if the user didn't send one
-    required: option.required ?? false,
-
-    // discord returns undefined if the user passed an empty array,
-    // so normalize undefined to an empty array
-    choices: ("choices" in option && option.choices) || [],
-
-    // Discord returns channel types in a specific order
-    channelTypes:
-      ("channelTypes" in option &&
-        sortChannelTypes(option.channelTypes ?? [])) ||
-      undefined,
-  }))
-
-  const commandData: ApplicationCommandData = {
-    name: config.name,
-    description: config.description,
-    options,
-  }
-
-  return createCommand({
-    name: config.name,
-
-    matchesExisting: (command) => {
-      if (command.type !== "CHAT_INPUT") return false
-
-      const existingCommandData: ChatInputApplicationCommandData = {
-        name: command.name,
-        description: command.description,
-        // need to use the same shape so they can be compared
-        options: command.options.map(
-          (option): ApplicationCommandOptionData => ({
-            name: option.name,
-            description: option.description,
-            type: option.type,
-            required: option.required,
-            choices: ("choices" in option && option.choices) || [],
-            /* option.channelTypes includes "UNKNOWN", but it's not allowed by ApplicationCommandOptionData */
-            channelTypes:
-              (("channelTypes" in option &&
-                option.channelTypes) as ApplicationCommandChannelOptionData["channelTypes"]) ||
-              undefined,
-          }),
-        ),
-      }
+export function createSlashCommands<
+  Options extends SlashCommandOptionConfigMap,
+>(config: SlashCommandConfig<Options>): Command[] {
+  const names = [config.name, ...(config.aliases || [])]
+
+  return names.map((name) => {
+    const options: ApplicationCommandOptionData[] = Object.entries(
+      config.options ?? {},
+    ).map(([name, option]) => ({
+      name,
+      description: option.description,
+      type: option.type,
+
+      // discord always returns a boolean, even if the user didn't send one
+      required: option.required ?? false,
+
+      // discord returns undefined if the user passed an empty array,
+      // so normalize undefined to an empty array
+      choices: ("choices" in option && option.choices) || [],
+
+      // Discord returns channel types in a specific order
+      channelTypes:
+        ("channelTypes" in option &&
+          sortChannelTypes(option.channelTypes ?? [])) ||
+        undefined,
+    }))
+
+    const commandData: ApplicationCommandData = {
+      name,
+      description: config.description,
+      options,
+    }
 
-      return isDeepEqual(commandData, existingCommandData)
-    },
-
-    register: async (manager) => {
-      await manager.create(commandData)
-    },
-
-    matchesInteraction: (interaction) => {
-      return interaction.isCommand() && interaction.commandName === config.name
-    },
-
-    run: async (interaction, command) => {
-      await config.run({
-        ...createInteractionContext({ interaction, command }),
-        options: collectSlashCommandOptionValues(
-          config,
-          interaction as CommandInteraction,
-        ),
-      })
-    },
+    return createCommand({
+      name,
+
+      matchesExisting: (command) => {
+        if (command.type !== "CHAT_INPUT") return false
+
+        const existingCommandData: ChatInputApplicationCommandData = {
+          name: command.name,
+          description: command.description,
+          // need to use the same shape so they can be compared
+          options: command.options.map(
+            (option): ApplicationCommandOptionData => ({
+              name: option.name,
+              description: option.description,
+              type: option.type,
+              required: option.required,
+              choices: ("choices" in option && option.choices) || [],
+              /* option.channelTypes includes "UNKNOWN", but it's not allowed by ApplicationCommandOptionData */
+              channelTypes:
+                (("channelTypes" in option &&
+                  option.channelTypes) as ApplicationCommandChannelOptionData["channelTypes"]) ||
+                undefined,
+            }),
+          ),
+        }
+
+        return isDeepEqual(commandData, existingCommandData)
+      },
+
+      register: async (manager) => {
+        await manager.create(commandData)
+      },
+
+      matchesInteraction: (interaction) => {
+        return interaction.isCommand() && interaction.commandName === name
+      },
+
+      run: async (interaction, command) => {
+        await config.run({
+          ...createInteractionContext({ interaction, command }),
+          options: collectSlashCommandOptionValues(
+            config,
+            interaction as CommandInteraction,
+          ),
+        })
+      },
+    })
   })
 }