From 0ac140cd9fd37b460552413f1632d4d647c95b7b Mon Sep 17 00:00:00 2001
From: Jaw0r3k <jaw0r3k.g@gmail.com>
Date: Thu, 5 Dec 2024 23:43:40 +0100
Subject: [PATCH] refactor!: escape expanded markdown by default (#9463)

feat: support markdown

BREAKING CHANGE: `heading`, `bulletedList`, `numberedList`, `maskedLink` in `EscapeMarkdownOptions` now defaults to `true`.

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
---
 packages/formatters/src/escapers.ts | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/packages/formatters/src/escapers.ts b/packages/formatters/src/escapers.ts
index 118707616..bceaf484f 100644
--- a/packages/formatters/src/escapers.ts
+++ b/packages/formatters/src/escapers.ts
@@ -14,7 +14,7 @@ export interface EscapeMarkdownOptions {
 	/**
 	 * Whether to escape bulleted lists.
 	 *
-	 * @defaultValue `false`
+	 * @defaultValue `true`
 	 */
 	bulletedList?: boolean;
 
@@ -42,7 +42,7 @@ export interface EscapeMarkdownOptions {
 	/**
 	 * Whether to escape headings.
 	 *
-	 * @defaultValue `false`
+	 * @defaultValue `true`
 	 */
 	heading?: boolean;
 
@@ -69,14 +69,14 @@ export interface EscapeMarkdownOptions {
 	/**
 	 * Whether to escape masked links.
 	 *
-	 * @defaultValue `false`
+	 * @defaultValue `true`
 	 */
 	maskedLink?: boolean;
 
 	/**
 	 * Whether to escape numbered lists.
 	 *
-	 * @defaultValue `false`
+	 * @defaultValue `true`
 	 */
 	numberedList?: boolean;
 
@@ -120,10 +120,10 @@ export function escapeMarkdown(text: string, options: EscapeMarkdownOptions = {}
 		codeBlockContent = true,
 		inlineCodeContent = true,
 		escape = true,
-		heading = false,
-		bulletedList = false,
-		numberedList = false,
-		maskedLink = false,
+		heading = true,
+		bulletedList = true,
+		numberedList = true,
+		maskedLink = true,
 	} = options;
 
 	if (!codeBlockContent) {