Make /coin check default to the caller (#282)

* Make `/coin check` default to the caller

`/coin check` originally had a mandatory argument of a target user to
check the balance of. Now the argument defaults to the user who called
the command, making it more ergonomic to use.

* Remove .coin balance subcommand

* Add check for if caller is checking own balance

- Also generalizes getUserIDFromMessage to just get the User straight up
    - Updated previou references where relevant (leaderboard)
- Replaces "`user` has" with `You have` if the user is calling `/coin check`
on their own

* Add additional aliases for `/coin check`

- `'b', 'bal', 'balance'` due to the removal of the balance subcommand

* Fix linter error

Author: hydrobeam

src/codeyCommand.ts

@@ -178,12 +178,17 @@ const setCommandSubcommand = (
   });
 };
 
-/** Helper method to get user id from message */
-export const getUserIdFromMessage = (message: Message | SapphireCommand.ChatInputInteraction): string => {
+/**
+ * Gets the User object from a message response.
+ *
+ * Retrieving the `User` depends on whether slash commands were used or not.
+ * This method helps generalize this process.
+ * */
+export const getUserFromMessage = (message: Message | SapphireCommand.ChatInputInteraction): User => {
   if (message instanceof Message) {
-    return message.author.id;
+    return message.author;
   } else {
-    return message.user.id;
+    return message.user;
   }
 };
 

src/commandDetails/coin/balance.ts

@@ -5,33 +5,44 @@ import {
   CodeyCommandOptionType,
   CodeyCommandResponseType,
   SapphireMessageExecuteType,
-  SapphireMessageResponse
+  SapphireMessageResponse,
+  getUserFromMessage
 } from '../../codeyCommand';
 import { getCoinBalanceByUserId } from '../../components/coin';
 import { getCoinEmoji } from '../../components/emojis';
 
 // Check a user's balance
 const coinCheckExecuteCommand: SapphireMessageExecuteType = async (
   _client,
-  _messageFromUser,
+  messageFromUser,
   args
 ): Promise<SapphireMessageResponse> => {
-  // Mandatory argument is user
-  const user = <User>args['user'];
+  let user: User;
+  let displayMessage: string;
+
+  // use the caller as a default user if no argument is provided
+  if (args['user']) {
+    user = <User>args['user'];
+    displayMessage = `${user.username} has`;
+  } else {
+    user = getUserFromMessage(messageFromUser);
+    displayMessage = `You have`;
+  }
   // Get coin balance
   let balance: number;
   try {
     balance = await getCoinBalanceByUserId(user.id);
   } catch (e) {
     return `Could not fetch the user's balance, contact a mod for help`;
   }
+
   // Show coin balance
-  return `${user.username} has ${balance} Codey coins ${getCoinEmoji()}.`;
+  return `${displayMessage} ${balance} Codey coins ${getCoinEmoji()}.`;
 };
 
 export const coinCheckCommandDetails: CodeyCommandDetails = {
   name: 'check',
-  aliases: ['c'],
+  aliases: ['c', 'b', 'balance', 'bal'],
   description: "Check a user's coin balance.",
   detailedDescription: `**Examples:**
 \`${container.botPrefix}coin check @Codey\`
@@ -47,7 +58,7 @@ export const coinCheckCommandDetails: CodeyCommandDetails = {
       name: 'user',
       description: 'The user to check the balance of,',
       type: CodeyCommandOptionType.USER,
-      required: true
+      required: false
     }
   ],
   subcommandDetails: {}

src/commandDetails/coin/check.ts

@@ -3,7 +3,7 @@ import { MessageEmbed, User } from 'discord.js';
 import {
   CodeyCommandDetails,
   CodeyCommandResponseType,
-  getUserIdFromMessage,
+  getUserFromMessage,
   SapphireMessageExecuteType,
   SapphireMessageResponse
 } from '../../codeyCommand';
@@ -61,7 +61,7 @@ const coinCurrentLeaderboardExecuteCommand: SapphireMessageExecuteType = async (
   messageFromUser,
   _args
 ): Promise<SapphireMessageResponse> => {
-  const userId = getUserIdFromMessage(messageFromUser);
+  const userId = getUserFromMessage(messageFromUser).id;
   // Get extra users to filter bots later
   const leaderboard = await getCurrentCoinLeaderboard(limit * 2);
   return { embeds: [await getCurrentCoinLeaderboardEmbed(client, leaderboard, userId)] };

src/commandDetails/coin/leaderboard.ts

@@ -1,7 +1,6 @@
 import { Command, container } from '@sapphire/framework';
 import { CodeyCommand, CodeyCommandDetails } from '../../codeyCommand';
 import { coinAdjustCommandDetails } from '../../commandDetails/coin/adjust';
-import { coinBalanceCommandDetails } from '../../commandDetails/coin/balance';
 import { coinCheckCommandDetails } from '../../commandDetails/coin/check';
 import { coinInfoCommandDetails } from '../../commandDetails/coin/info';
 import { coinUpdateCommandDetails } from '../../commandDetails/coin/update';
@@ -15,8 +14,6 @@ const coinCommandDetails: CodeyCommandDetails = {
 \`${container.botPrefix}coin adjust @Codey 100\`
 \`${container.botPrefix}coin adjust @Codey -100 Codey broke.\`
 \`${container.botPrefix}coin\`
-\`${container.botPrefix}bal\`
-\`${container.botPrefix}balance\`
 \`${container.botPrefix}coin check @Codey\`
 \`${container.botPrefix}coin c @Codey\`
 \`${container.botPrefix}coin info\`
@@ -26,13 +23,12 @@ const coinCommandDetails: CodeyCommandDetails = {
   options: [],
   subcommandDetails: {
     adjust: coinAdjustCommandDetails,
-    balance: coinBalanceCommandDetails,
     check: coinCheckCommandDetails,
     info: coinInfoCommandDetails,
     update: coinUpdateCommandDetails,
     leaderboard: coinCurrentLeaderboardCommandDetails
   },
-  defaultSubcommandDetails: coinBalanceCommandDetails
+  defaultSubcommandDetails: coinCheckCommandDetails
 };
 
 export class CoinCommand extends CodeyCommand {