aboutsummaryrefslogtreecommitdiff
path: root/src/lib/common/util/Format.ts
blob: 6cb6edc9e51b1c3e9b6af8f33d9bac862f3c5d57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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, '');
	}
}