refactoring & documentation

1 files changed, 107 insertions, 0 deletions

diff --git a/src/lib/common/util/Format.ts b/src/lib/common/util/Format.ts
new file mode 100644
index 0000000..6cb6edc
--- /dev/null
+++ b/src/lib/common/util/Format.ts
@@ -0,0 +1,107 @@
+import { type CodeBlockLang } from '#lib';
+import { EscapeMarkdownOptions, Formatters, Util } from 'discord.js';
+
+/**
+ * Formats and escapes content for formatting
+ */
+export class Format {
+	/**
+	 * Wraps the content inside a codeblock with no language.
+	 * @param content The content to wrap.
+	 */
+	public static codeBlock(content: string): string;
+
+	/**
+	 * Wraps the content inside a codeblock with the specified language.
+	 * @param language The language for the codeblock.
+	 * @param content The content to wrap.
+	 */
+	public static codeBlock(language: CodeBlockLang, content: string): string;
+	public static codeBlock(languageOrContent: string, content?: string): string {
+		return typeof content === 'undefined'
+			? Formatters.codeBlock(Util.escapeCodeBlock(`${languageOrContent}`))
+			: Formatters.codeBlock(`${languageOrContent}`, Util.escapeCodeBlock(`${content}`));
+	}
+
+	/**
+	 * Wraps the content inside \`backticks\`, which formats it as inline code.
+	 * @param content The content to wrap.
+	 */
+	public static inlineCode(content: string): string {
+		return Formatters.inlineCode(Util.escapeInlineCode(`${content}`));
+	}
+
+	/**
+	 * Formats the content into italic text.
+	 * @param content The content to wrap.
+	 */
+	public static italic(content: string): string {
+		return Formatters.italic(Util.escapeItalic(`${content}`));
+	}
+
+	/**
+	 * Formats the content into bold text.
+	 * @param content The content to wrap.
+	 */
+	public static bold(content: string): string {
+		return Formatters.bold(Util.escapeBold(`${content}`));
+	}
+
+	/**
+	 * Formats the content into underscored text.
+	 * @param content The content to wrap.
+	 */
+	public static underscore(content: string): string {
+		return Formatters.underscore(Util.escapeUnderline(`${content}`));
+	}
+
+	/**
+	 * Formats the content into strike-through text.
+	 * @param content The content to wrap.
+	 */
+	public static strikethrough(content: string): string {
+		return Formatters.strikethrough(Util.escapeStrikethrough(`${content}`));
+	}
+
+	/**
+	 * Wraps the content inside spoiler (hidden text).
+	 * @param content The content to wrap.
+	 */
+	public static spoiler(content: string): string {
+		return Formatters.spoiler(Util.escapeSpoiler(`${content}`));
+	}
+
+	/**
+	 * Escapes any Discord-flavour markdown in a string.
+	 * @param text Content to escape
+	 * @param options Options for escaping the markdown
+	 */
+	public static escapeMarkdown(text: string, options?: EscapeMarkdownOptions): string {
+		return Util.escapeMarkdown(`${text}`, options);
+	}
+
+	/**
+	 * Formats input: makes it bold and escapes any other markdown
+	 * @param text The input
+	 */
+	public static input(text: string): string {
+		return this.bold(this.escapeMarkdown(this.sanitizeWtlAndControl(`${text}`)));
+	}
+
+	/**
+	 * Formats input for logs: makes it highlighted
+	 * @param text The input
+	 */
+	public static inputLog(text: string): string {
+		return `<<${this.sanitizeWtlAndControl(`${text}`)}>>`;
+	}
+
+	/**
+	 * Removes all characters in a string that are either control characters or change the direction of text etc.
+	 * @param str The string you would like sanitized
+	 */
+	public static sanitizeWtlAndControl(str: string) {
+		// eslint-disable-next-line no-control-regex
+		return `${str}`.replace(/[\u0000-\u001F\u007F-\u009F\u200B]/g, '');
+	}
+}