feat: add strikethrough and underline

readme.md

@@ -57,6 +57,22 @@ Type: `string`
 
 Text to be formatted italic
 
+### strikethrough(text)
+
+#### text
+
+Type: `string`
+
+Text to be striked through
+
+### underline(text)
+
+#### text
+
+Type: `string`
+
+Text to be underlined
+
 ### monospace(text)
 
 #### text

source/html.ts

@@ -17,6 +17,14 @@ function italic(text: string): string {
 	return `<i>${escape(text)}</i>`
 }
 
+function strikethrough(text: string): string {
+	return `<s>${escape(text)}</s>`
+}
+
+function underline(text: string): string {
+	return `<u>${escape(text)}</u>`
+}
+
 function monospace(text: string): string {
 	return `<code>${escape(text)}</code>`
 }
@@ -42,6 +50,8 @@ export const html: Formatter = {
 	escape,
 	bold,
 	italic,
+	strikethrough,
+	underline,
 	monospace,
 	monospaceBlock,
 	url,

source/interface.ts

@@ -5,6 +5,8 @@ export interface Formatter {
 	italic: (text: string) => string;
 	monospace: (text: string) => string;
 	monospaceBlock: (text: string, programmingLanguage?: string) => string;
+	strikethrough: (text: string) => string;
+	underline: (text: string) => string;
 	url: (label: string, url: string) => string;
 	userMention: (label: string, userId: number) => string;
 }

source/markdown.ts

@@ -14,6 +14,14 @@ function italic(text: string): string {
 	return `_${text.replace(/_/g, '')}_`
 }
 
+function strikethrough(_text: string): string {
+	throw new Error('strikethrough is not supported by Markdown. Use MarkdownV2 instead.')
+}
+
+function underline(_text: string): string {
+	throw new Error('underline is not supported by Markdown. Use MarkdownV2 instead.')
+}
+
 function monospace(text: string): string {
 	return '`' + text.replace(/`/g, '') + '`'
 }
@@ -46,6 +54,8 @@ export const markdown: Formatter = {
 	escape,
 	bold,
 	italic,
+	strikethrough,
+	underline,
 	monospace,
 	monospaceBlock,
 	url,

source/markdownv2.ts

@@ -18,6 +18,14 @@ function italic(text: string): string {
 	return `_${escape(text)}_`
 }
 
+function strikethrough(text: string): string {
+	return `~${escape(text)}~`
+}
+
+function underline(text: string): string {
+	return `__${escape(text)}__`
+}
+
 function monospace(text: string): string {
 	return '`' + escapeInteral(text, '`') + '`'
 }
@@ -50,6 +58,8 @@ export const markdownv2: Formatter = {
 	escape,
 	bold,
 	italic,
+	strikethrough,
+	underline,
 	monospace,
 	monospaceBlock,
 	url,

test/html.ts

@@ -10,6 +10,14 @@ test('italic', t => {
 	t.is(format.italic('italic'), '<i>italic</i>')
 })
 
+test('strikethrough', t => {
+	t.is(format.strikethrough('strikethrough'), '<s>strikethrough</s>')
+})
+
+test('underline', t => {
+	t.is(format.underline('underline'), '<u>underline</u>')
+})
+
 test('url', t => {
 	t.is(format.url('me', 'https://edjopato.de'), '<a href="https://edjopato.de">me</a>')
 })

test/markdown.ts

@@ -41,3 +41,21 @@ test('monospaceBlock w/o language', t => {
 test('monospaceBlock w/ language', t => {
 	t.is(format.monospaceBlock('pre-formatted fixed-width code block written in the Python programming language', 'python'), '```python\npre-formatted fixed-width code block written in the Python programming language\n```')
 })
+
+test('strikethrough', t => {
+	t.throws(
+		() => format.strikethrough('1337'),
+		{
+			message: 'strikethrough is not supported by Markdown. Use MarkdownV2 instead.'
+		}
+	)
+})
+
+test('underline', t => {
+	t.throws(
+		() => format.underline('1337'),
+		{
+			message: 'underline is not supported by Markdown. Use MarkdownV2 instead.'
+		}
+	)
+})

test/markdownv2.ts

@@ -10,6 +10,14 @@ test('italic', t => {
 	t.is(format.italic('italic'), '_italic_')
 })
 
+test('strikethrough', t => {
+	t.is(format.strikethrough('strikethrough'), '~strikethrough~')
+})
+
+test('underline', t => {
+	t.is(format.underline('underline'), '__underline__')
+})
+
 test('url', t => {
 	t.is(format.url('me', 'https://edjopato.de'), '[me](https://edjopato.de)')
 })