From 16074dec13165e3f3b962cb64ca4692689d618e3 Mon Sep 17 00:00:00 2001
From: Spurk <oscartang.dev@gmail.com>
Date: Fri, 6 Dec 2024 18:25:13 +1100
Subject: [PATCH] add underscore_spaces with new funbox package refactor

---
 frontend/src/styles/test.scss                   |  7 +++++++
 frontend/src/ts/pages/settings.ts               |  3 +++
 frontend/src/ts/test/funbox/funbox-functions.ts | 12 ++++++++++++
 packages/funbox/src/list.ts                     |  8 ++++++++
 packages/funbox/src/types.ts                    |  3 ++-
 5 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/frontend/src/styles/test.scss b/frontend/src/styles/test.scss
index 8a437be056ff..2d06e5bb28c5 100644
--- a/frontend/src/styles/test.scss
+++ b/frontend/src/styles/test.scss
@@ -1338,6 +1338,13 @@ body.fb-nospace {
   }
 }
 
+/* funbox underscore_spaces */
+body.fb-underscore-spaces {
+  #words .word {
+    margin: 0.5em 0;
+  }
+}
+
 /* funbox arrows */
 body.fb-arrows {
   #words .word {
diff --git a/frontend/src/ts/pages/settings.ts b/frontend/src/ts/pages/settings.ts
index 5b7e507d6649..2f1cf76b0847 100644
--- a/frontend/src/ts/pages/settings.ts
+++ b/frontend/src/ts/pages/settings.ts
@@ -612,6 +612,9 @@ async function fillSettingsPage(): Promise<void> {
         /_/g,
         " "
       )}</div>`;
+    } else if (funbox.name === "underscore_spaces") {
+      // Display as "underscore_spaces". Does not replace underscores with spaces.
+      funboxElHTML += `<div class="funbox button" data-config-value='${funbox.name}' aria-label="${funbox.description}" data-balloon-pos="up" data-balloon-length="fit">${funbox.name}</div>`;
     } else {
       funboxElHTML += `<div class="funbox button" data-config-value='${
         funbox.name
diff --git a/frontend/src/ts/test/funbox/funbox-functions.ts b/frontend/src/ts/test/funbox/funbox-functions.ts
index 73d6069790c6..3df868bb903b 100644
--- a/frontend/src/ts/test/funbox/funbox-functions.ts
+++ b/frontend/src/ts/test/funbox/funbox-functions.ts
@@ -584,6 +584,18 @@ const list: Partial<Record<FunboxName, FunboxFunctions>> = {
       return GetText.getMorse(word);
     },
   },
+  underscore_spaces: {
+    rememberSettings(): void {
+      save(
+        "highlightMode",
+        Config.highlightMode,
+        UpdateConfig.setHighlightMode
+      );
+    },
+    alterText(word: string): string {
+      return word + "_"; //add underscore at the end instead of space
+    },
+  },
   crt: {
     applyGlobalCSS(): void {
       const isSafari = /^((?!chrome|android).)*safari/i.test(
diff --git a/packages/funbox/src/list.ts b/packages/funbox/src/list.ts
index 06a5055f5cae..64b053587fe2 100644
--- a/packages/funbox/src/list.ts
+++ b/packages/funbox/src/list.ts
@@ -406,6 +406,14 @@ const list: Record<FunboxName, FunboxMetadata> = {
     frontendFunctions: ["alterText"],
     name: "instant_messaging",
   },
+  underscore_spaces: {
+    description: "Underscores_are_better.",
+    canGetPb: false,
+    difficultyLevel: 0,
+    properties: ["ignoresLanguage", "ignoresLayout", "nospace"],
+    frontendFunctions: ["alterText", "applyConfig", "rememberSettings"],
+    name: "underscore_spaces",
+  },
 };
 
 export function getFunbox(name: FunboxName): FunboxMetadata;
diff --git a/packages/funbox/src/types.ts b/packages/funbox/src/types.ts
index 8a19d91174bc..dbdb745e0aa5 100644
--- a/packages/funbox/src/types.ts
+++ b/packages/funbox/src/types.ts
@@ -38,7 +38,8 @@ export type FunboxName =
   | "crt"
   | "backwards"
   | "ddoouubblleedd"
-  | "instant_messaging";
+  | "instant_messaging"
+  | "underscore_spaces";
 
 export type FunboxForcedConfig = Record<string, string[] | boolean[]>;