feat: add subtext formatter (#10400)

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
discordjs · Jul 24, 2024 · fcd35ea · fcd35ea
1 parent b2970bb
commit fcd35ea
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/packages/formatters/__tests__/formatters.test.ts b/packages/formatters/__tests__/formatters.test.ts
@@ -23,6 +23,7 @@ import {
 	roleMention,
 	spoiler,
 	strikethrough,
+	subtext,
 	time,
 	TimestampStyles,
 	underline,
@@ -277,6 +278,12 @@ describe('Message formatters', () => {
 		});
 	});
 
+	describe('subtext', () => {
+		test('GIVEN "discord.js" THEN returns "-# discord.js"', () => {
+			expect<'-# discord.js'>(subtext('discord.js')).toEqual('-# discord.js');
+		});
+	});
+
 	describe('time', () => {
 		test('GIVEN no arguments THEN returns "<t:${bigint}>"', () => {
 			vitest.useFakeTimers();

diff --git a/packages/formatters/src/formatters.ts b/packages/formatters/src/formatters.ts
@@ -569,6 +569,16 @@ export function unorderedList(list: RecursiveArray<string>): string {
 	return listCallback(list);
 }
 
+/**
+ * Formats the content into a subtext.
+ *
+ * @typeParam Content - This is inferred by the supplied content
+ * @param content - The content to wrap
+ */
+export function subtext<Content extends string>(content: Content): `-# ${Content}` {
+	return `-# ${content}`;
+}
+
 /**
  * Formats a date into a short date-time string.
  *