diff --git a/packages/formatters/__tests__/formatters.test.ts b/packages/formatters/__tests__/formatters.test.ts index a257e56b9..519157f4e 100644 --- a/packages/formatters/__tests__/formatters.test.ts +++ b/packages/formatters/__tests__/formatters.test.ts @@ -17,6 +17,7 @@ import { hyperlink, inlineCode, italic, + linkedRoleMention, messageLink, orderedList, quote, @@ -147,6 +148,12 @@ describe('Message formatters', () => { }); }); + describe('linkedRoleMention', () => { + test('GIVEN roleId THEN returns ""', () => { + expect(linkedRoleMention('815434166602170409')).toEqual(''); + }); + }); + describe('chatInputApplicationCommandMention', () => { test('GIVEN commandName and commandId THEN returns ""', () => { expect(chatInputApplicationCommandMention('airhorn', '815434166602170409')).toEqual( diff --git a/packages/formatters/src/formatters.ts b/packages/formatters/src/formatters.ts index 591db60c8..83644e013 100644 --- a/packages/formatters/src/formatters.ts +++ b/packages/formatters/src/formatters.ts @@ -225,6 +225,16 @@ export function roleMention(roleId: RoleId): `<@&${Rol return `<@&${roleId}>`; } +/** + * Formats a role id into a linked role mention. + * + * @typeParam RoleId - This is inferred by the supplied role id + * @param roleId - The role id to format + */ +export function linkedRoleMention(roleId: RoleId): `` { + return ``; +} + /** * Formats an application command name, subcommand group name, subcommand name, and id into an application command mention. * @@ -808,4 +818,8 @@ export enum GuildNavigationMentions { * {@link https://support.discord.com/hc/articles/13497665141655 | Server Guide} tab. */ Guide = '', + /** + * {@link https://support.discord.com/hc/articles/10388356626711 | Linked Roles} tab. + */ + LinkedRoles = '', }