From 3ddb73287bb1c834c25e19de847b5dfa193b75f9 Mon Sep 17 00:00:00 2001
From: Jiralite <33201955+Jiralite@users.noreply.github.com>
Date: Sun, 12 Jan 2025 20:09:03 +0000
Subject: [PATCH] refactor!: Better application command mention format approach
 (#10639)

BREAKING CHANGE: The parameters of `chatInputApplicationCommandMention()` have been reordered.
---
 .../formatters/__tests__/formatters.test.ts   | 12 +--
 packages/formatters/src/formatters.ts         | 78 +++++++++----------
 2 files changed, 45 insertions(+), 45 deletions(-)

diff --git a/packages/formatters/__tests__/formatters.test.ts b/packages/formatters/__tests__/formatters.test.ts
index c91f4c694..628683813 100644
--- a/packages/formatters/__tests__/formatters.test.ts
+++ b/packages/formatters/__tests__/formatters.test.ts
@@ -153,20 +153,20 @@ describe('Message formatters', () => {
 		});
 
 		describe('chatInputApplicationCommandMention', () => {
-			test('GIVEN commandName and commandId THEN returns "</[commandName]:[commandId]>"', () => {
-				expect(chatInputApplicationCommandMention('airhorn', '815434166602170409')).toEqual(
+			test('GIVEN commandId and commandName THEN returns "</[commandName]:[commandId]>"', () => {
+				expect(chatInputApplicationCommandMention('815434166602170409', 'airhorn')).toEqual(
 					'</airhorn:815434166602170409>',
 				);
 			});
 
-			test('GIVEN commandName, subcommandName, and commandId THEN returns "</[commandName] [subcommandName]:[commandId]>"', () => {
-				expect(chatInputApplicationCommandMention('airhorn', 'sub', '815434166602170409')).toEqual(
+			test('GIVEN commandId, commandName, subcommandName  THEN returns "</[commandName] [subcommandName]:[commandId]>"', () => {
+				expect(chatInputApplicationCommandMention('815434166602170409', 'airhorn', 'sub')).toEqual(
 					'</airhorn sub:815434166602170409>',
 				);
 			});
 
-			test('GIVEN commandName, subcommandGroupName, subcommandName, and commandId THEN returns "</[commandName] [subcommandGroupName] [subcommandName]:[commandId]>"', () => {
-				expect(chatInputApplicationCommandMention('airhorn', 'group', 'sub', '815434166602170409')).toEqual(
+			test('GIVEN commandId, commandName, subcommandName, and subcommandGroupName, THEN returns "</[commandName] [subcommandGroupName] [subcommandName]:[commandId]>"', () => {
+				expect(chatInputApplicationCommandMention('815434166602170409', 'airhorn', 'sub', 'group')).toEqual(
 					'</airhorn group sub:815434166602170409>',
 				);
 			});
diff --git a/packages/formatters/src/formatters.ts b/packages/formatters/src/formatters.ts
index 65c7af555..22914c368 100644
--- a/packages/formatters/src/formatters.ts
+++ b/packages/formatters/src/formatters.ts
@@ -225,85 +225,85 @@ export function linkedRoleMention<RoleId extends Snowflake>(roleId: RoleId): `<i
 }
 
 /**
- * Formats an application command name, subcommand group name, subcommand name, and id into an application command mention.
+ * Formats an application command name and id into an application command mention.
  *
- * @typeParam CommandName - This is inferred by the supplied command name
- * @typeParam SubcommandGroupName - This is inferred by the supplied subcommand group name
- * @typeParam SubcommandName - This is inferred by the supplied subcommand name
  * @typeParam CommandId - This is inferred by the supplied command id
- * @param commandName - The application command name to format
- * @param subcommandGroupName - The subcommand group name to format
- * @param subcommandName - The subcommand name to format
+ * @typeParam CommandName - This is inferred by the supplied command name
  * @param commandId - The application command id to format
+ * @param commandName - The application command name to format
  */
-export function chatInputApplicationCommandMention<
-	CommandName extends string,
-	SubcommandGroupName extends string,
-	SubcommandName extends string,
-	CommandId extends Snowflake,
->(
-	commandName: CommandName,
-	subcommandGroupName: SubcommandGroupName,
-	subcommandName: SubcommandName,
+export function chatInputApplicationCommandMention<CommandId extends Snowflake, CommandName extends string>(
 	commandId: CommandId,
-): `</${CommandName} ${SubcommandGroupName} ${SubcommandName}:${CommandId}>`;
+	commandName: CommandName,
+): `</${CommandName}:${CommandId}>`;
 
 /**
  * Formats an application command name, subcommand name, and id into an application command mention.
  *
+ * @typeParam CommandId - This is inferred by the supplied command id
  * @typeParam CommandName - This is inferred by the supplied command name
  * @typeParam SubcommandName - This is inferred by the supplied subcommand name
- * @typeParam CommandId - This is inferred by the supplied command id
+ * @param commandId - The application command id to format
  * @param commandName - The application command name to format
  * @param subcommandName - The subcommand name to format
- * @param commandId - The application command id to format
  */
 export function chatInputApplicationCommandMention<
+	CommandId extends Snowflake,
 	CommandName extends string,
 	SubcommandName extends string,
-	CommandId extends Snowflake,
 >(
+	commandId: CommandId,
 	commandName: CommandName,
 	subcommandName: SubcommandName,
-	commandId: CommandId,
 ): `</${CommandName} ${SubcommandName}:${CommandId}>`;
 
 /**
- * Formats an application command name and id into an application command mention.
+ * Formats an application command name, subcommand group name, subcommand name, and id into an application command mention.
  *
- * @typeParam CommandName - This is inferred by the supplied command name
  * @typeParam CommandId - This is inferred by the supplied command id
- * @param commandName - The application command name to format
+ * @typeParam CommandName - This is inferred by the supplied command name
+ * @typeParam SubcommandName - This is inferred by the supplied subcommand name
+ * @typeParam SubcommandGroupName - This is inferred by the supplied subcommand group name
  * @param commandId - The application command id to format
+ * @param commandName - The application command name to format
+ * @param subcommandName - The subcommand name to format
+ * @param subcommandGroupName - The subcommand group name to format
  */
-export function chatInputApplicationCommandMention<CommandName extends string, CommandId extends Snowflake>(
-	commandName: CommandName,
+export function chatInputApplicationCommandMention<
+	CommandId extends Snowflake,
+	CommandName extends string,
+	SubcommandName extends string,
+	SubcommandGroupName extends string,
+>(
 	commandId: CommandId,
-): `</${CommandName}:${CommandId}>`;
+	commandName: CommandName,
+	subcommandName: SubcommandName,
+	subcommandGroupName: SubcommandGroupName,
+): `</${CommandName} ${SubcommandGroupName} ${SubcommandName}:${CommandId}>`;
 
 export function chatInputApplicationCommandMention<
-	CommandName extends string,
-	SubcommandGroupName extends Snowflake | string,
-	SubcommandName extends Snowflake | string,
 	CommandId extends Snowflake,
+	CommandName extends string,
+	SubcommandName extends string,
+	SubcommandGroupName extends string,
 >(
+	commandId: CommandId,
 	commandName: CommandName,
-	subcommandGroupName: SubcommandGroupName,
-	subcommandName?: SubcommandName,
-	commandId?: CommandId,
+	subcommandName?: SubcommandName | undefined,
+	subcommandGroupName?: SubcommandGroupName | undefined,
 ):
 	| `</${CommandName} ${SubcommandGroupName} ${SubcommandName}:${CommandId}>`
-	| `</${CommandName} ${SubcommandGroupName}:${SubcommandName}>`
-	| `</${CommandName}:${SubcommandGroupName}>` {
-	if (commandId !== undefined) {
-		return `</${commandName} ${subcommandGroupName} ${subcommandName!}:${commandId}>`;
+	| `</${CommandName} ${SubcommandName}:${CommandId}>`
+	| `</${CommandName}:${CommandId}>` {
+	if (subcommandGroupName !== undefined && subcommandName !== undefined) {
+		return `</${commandName} ${subcommandGroupName} ${subcommandName}:${commandId}>`;
 	}
 
 	if (subcommandName !== undefined) {
-		return `</${commandName} ${subcommandGroupName}:${subcommandName}>`;
+		return `</${commandName} ${subcommandName}:${commandId}>`;
 	}
 
-	return `</${commandName}:${subcommandGroupName}>`;
+	return `</${commandName}:${commandId}>`;
 }
 
 /**