feat: commands run method returning boolean

BREAKING CHANGE: commands `run` method returning boolean
larsrickert · Jun 17, 2022 · 3031a21 · 3031a21
1 parent f97dc90
commit 3031a21
Show file tree

Hide file tree

Showing 14 changed files with 49 additions and 19 deletions.
diff --git a/src/commands/add.ts b/src/commands/add.ts
@@ -22,10 +22,10 @@ export const createAddCommand: CreateCommandFunc = (playerManager, options) => {
         false,
         options
       );
-      if (!searchResult) return;
+      if (!searchResult) return false;
 
       if (searchResult.playlist) {
-        return await interaction.followUp({
+        await interaction.followUp({
           content: playerManager.translations.add.successPlaylist.replace(
             "{playlist}",
             urlToMarkdown(
@@ -35,6 +35,7 @@ export const createAddCommand: CreateCommandFunc = (playerManager, options) => {
             )
           ),
         });
+        return true;
       }
 
       await interaction.followUp({
@@ -43,6 +44,7 @@ export const createAddCommand: CreateCommandFunc = (playerManager, options) => {
           trackToMarkdown(searchResult.tracks[0], true)
         ),
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/clear.ts b/src/commands/clear.ts
@@ -10,10 +10,11 @@ export const createClearCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const count = player.clear();
@@ -24,6 +25,7 @@ export const createClearCommand: CreateCommandFunc = (
         ),
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/help.ts b/src/commands/help.ts
@@ -38,6 +38,7 @@ export const createHelpCommand = (
         ],
         ephemeral: true,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/pause.ts b/src/commands/pause.ts
@@ -10,24 +10,27 @@ export const createPauseCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const paused = player.setPause(true);
       if (!paused) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.pause.failure,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       await interaction.reply({
         content: playerManager.translations.pause.success,
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/play.ts b/src/commands/play.ts
@@ -25,10 +25,10 @@ export const createPlayCommand: CreateCommandFunc = (
         true,
         options
       );
-      if (!searchResult) return;
+      if (!searchResult) return false;
 
       if (searchResult.playlist) {
-        return await interaction.followUp({
+        await interaction.followUp({
           content: playerManager.translations.play.successPlaylist.replace(
             "{playlist}",
             urlToMarkdown(
@@ -37,6 +37,7 @@ export const createPlayCommand: CreateCommandFunc = (
             )
           ),
         });
+        return true;
       }
 
       await interaction.followUp({
@@ -45,6 +46,7 @@ export const createPlayCommand: CreateCommandFunc = (
           trackToMarkdown(searchResult.tracks[0])
         ),
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/queue.ts b/src/commands/queue.ts
@@ -11,20 +11,22 @@ export const createQueueCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const currentTrack = player.getCurrentTrack();
       const tracks = player.getQueue();
 
       if (!currentTrack || !tracks.length) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.queue.empty,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       let content = `>>> **Queue (${tracks.length})**`;
@@ -47,6 +49,7 @@ export const createQueueCommand: CreateCommandFunc = (
       }
 
       await interaction.reply({ content, ephemeral: options?.ephemeral });
+      return true;
     },
   };
 };
diff --git a/src/commands/repeat.ts b/src/commands/repeat.ts
@@ -35,10 +35,11 @@ export const createRepeatCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const mode = interaction.options.getInteger(
@@ -56,6 +57,7 @@ export const createRepeatCommand: CreateCommandFunc = (
         ),
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/resume.ts b/src/commands/resume.ts
@@ -10,24 +10,27 @@ export const createResumeCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const paused = player.setPause(false);
       if (!paused) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.resume.failure,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       await interaction.reply({
         content: playerManager.translations.resume.success,
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/shuffle.ts b/src/commands/shuffle.ts
@@ -10,10 +10,11 @@ export const createShuffleCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       player.shuffle();
@@ -22,6 +23,7 @@ export const createShuffleCommand: CreateCommandFunc = (
         content: playerManager.translations.shuffle.success,
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/skip.ts b/src/commands/skip.ts
@@ -11,19 +11,21 @@ export const createSkipCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const track = player.skip();
 
       if (!track) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.skip.failure,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       await interaction.reply({
@@ -33,6 +35,7 @@ export const createSkipCommand: CreateCommandFunc = (
         ),
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/song.ts b/src/commands/song.ts
@@ -13,10 +13,11 @@ export const createSongCommand: CreateCommandFunc = (
       const currentTrack = player?.getCurrentTrack();
 
       if (!player || !currentTrack) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       await interaction.reply({
@@ -26,6 +27,7 @@ export const createSongCommand: CreateCommandFunc = (
         ),
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/stop.ts b/src/commands/stop.ts
@@ -10,10 +10,11 @@ export const createStopCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       player.stop();
@@ -22,6 +23,7 @@ export const createStopCommand: CreateCommandFunc = (
         content: playerManager.translations.stop.success,
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/commands/volume.ts b/src/commands/volume.ts
@@ -21,10 +21,11 @@ export const createSetVolumeCommand: CreateCommandFunc = (
     run: async (interaction) => {
       const player = playerManager.find(interaction.guildId);
       if (!player) {
-        return await interaction.reply({
+        await interaction.reply({
           content: playerManager.translations.global.noGuildPlayer,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       const volume = interaction.options.getNumber("volume", true);
@@ -34,6 +35,7 @@ export const createSetVolumeCommand: CreateCommandFunc = (
           content: playerManager.translations.setvolume.failure,
           ephemeral: options?.ephemeralError ?? true,
         });
+        return false;
       }
 
       await interaction.reply({
@@ -43,6 +45,7 @@ export const createSetVolumeCommand: CreateCommandFunc = (
         ),
         ephemeral: options?.ephemeral,
       });
+      return true;
     },
   };
 };
diff --git a/src/types/commands.ts b/src/types/commands.ts
@@ -5,7 +5,7 @@ import {
 import en from "../languages/en.json";
 import { PlayerManager } from "../player-manager";
 
-export interface Command<T = unknown> extends ChatInputApplicationCommandData {
+export interface Command<T = boolean> extends ChatInputApplicationCommandData {
   run: (interaction: CommandInteraction<"cached">) => Promise<T>;
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -38,6 +38,7 @@ export const createHelpCommand = ( @@
             ],
             ephemeral: true,
           });
+          return true;
         },
       };
     };