chore: rename functions (to make upcoming pr diff easier to parse)

Miodec · mshareef-git · commit e0b1932ff8f8 · 2026-05-06T06:59:33.000+05:30
diff --git a/frontend/src/ts/elements/caret.ts b/frontend/src/ts/elements/caret.ts
@@ -287,7 +287,7 @@ export class Caret {
       const word = wordsCache.qs(
         `.word[data-wordindex="${options.wordIndex}"]`,
       );
-      const wordText = TestWords.words.get(options.wordIndex) ?? "";
+      const wordText = TestWords.words.getText(options.wordIndex) ?? "";
       const wordLength = Array.from(wordText).length;
 
       // caret can be either on the left side of the target letter or the right
diff --git a/frontend/src/ts/input/handlers/before-delete.ts b/frontend/src/ts/input/handlers/before-delete.ts
@@ -43,7 +43,7 @@ export function onBeforeDelete(event: InputEvent): void {
   const confidence = Config.confidenceMode;
   const previousWordCorrect =
     (TestInput.input.get(TestState.activeWordIndex - 1) ?? "") ===
-    TestWords.words.get(TestState.activeWordIndex - 1);
+    TestWords.words.getText(TestState.activeWordIndex - 1);
 
   if (confidence === "on" && inputIsEmpty && !previousWordCorrect) {
     event.preventDefault();
diff --git a/frontend/src/ts/input/handlers/before-insert-text.ts b/frontend/src/ts/input/handlers/before-insert-text.ts
@@ -34,7 +34,7 @@ export function onBeforeInsertText(data: string): boolean {
   const shouldInsertSpaceAsCharacter = shouldInsertSpaceCharacter({
     data,
     inputValue,
-    targetWord: TestWords.words.getCurrent(),
+    targetWord: TestWords.words.getCurrentText(),
   });
 
   //prevent space from being inserted if input is empty
@@ -60,7 +60,7 @@ export function onBeforeInsertText(data: string): boolean {
 
   // block input if the word is too long
   const inputLimit =
-    Config.mode === "zen" ? 30 : TestWords.words.getCurrent().length + 20;
+    Config.mode === "zen" ? 30 : TestWords.words.getCurrentText().length + 20;
   const overLimit = TestInput.input.current.length >= inputLimit;
   if (overLimit && (shouldInsertSpaceAsCharacter === true || !dataIsSpace)) {
     console.error("Hitting word limit");
@@ -71,7 +71,7 @@ export function onBeforeInsertText(data: string): boolean {
   // this will not work for the first word of each line, but that has a low chance of happening
   const dataIsNotFalsy = data !== null && data !== "";
   const inputIsLongerThanOrEqualToWord =
-    TestInput.input.current.length >= TestWords.words.getCurrent().length;
+    TestInput.input.current.length >= TestWords.words.getCurrentText().length;
 
   if (
     !SlowTimer.get() && // don't do this check if slow timer is active
diff --git a/frontend/src/ts/input/handlers/delete.ts b/frontend/src/ts/input/handlers/delete.ts
@@ -20,7 +20,7 @@ export function onDelete(inputType: DeleteInputType): void {
 
   const beforeDeleteOnlyTabs = /^\t*$/.test(inputBeforeDelete);
   const allTabsCorrect = TestWords.words
-    .getCurrent()
+    .getCurrentText()
     .startsWith(TestInput.input.current);
 
   //special check for code languages
diff --git a/frontend/src/ts/input/handlers/insert-text.ts b/frontend/src/ts/input/handlers/insert-text.ts
@@ -85,7 +85,7 @@ export async function onInsertText(options: OnInsertTextParams): Promise<void> {
   const charOverride = charOverrides.get(options.data);
   if (
     charOverride !== undefined &&
-    TestWords.words.getCurrent()[TestInput.input.current.length] !==
+    TestWords.words.getCurrentText()[TestInput.input.current.length] !==
       options.data
   ) {
     // replace the data with the override
@@ -101,7 +101,7 @@ export async function onInsertText(options: OnInsertTextParams): Promise<void> {
 
   // input and target word
   const testInput = TestInput.input.current;
-  const currentWord = TestWords.words.getCurrent();
+  const currentWord = TestWords.words.getCurrentText();
 
   // if the character is visually equal, replace it with the target character
   // this ensures all future equivalence checks work correctly
@@ -151,7 +151,7 @@ export async function onInsertText(options: OnInsertTextParams): Promise<void> {
   // word navigation check
   const noSpaceForce =
     isFunboxActiveWithProperty("nospace") &&
-    (testInput + data).length === TestWords.words.getCurrent().length;
+    (testInput + data).length === TestWords.words.getCurrentText().length;
   const shouldGoToNextWord =
     ((charIsSpace || charIsNewline) && !shouldInsertSpace) || noSpaceForce;
 
@@ -169,7 +169,7 @@ export async function onInsertText(options: OnInsertTextParams): Promise<void> {
   TestInput.pushKeypressWord(wordIndex);
   if (!correct) {
     TestInput.incrementKeypressErrors();
-    TestInput.pushMissedWord(TestWords.words.getCurrent());
+    TestInput.pushMissedWord(TestWords.words.getCurrentText());
   }
   if (Config.keymapMode === "react") {
     flash(data, correct);
@@ -236,7 +236,7 @@ export async function onInsertText(options: OnInsertTextParams): Promise<void> {
   */
 
   //this COULD be the next word because we are awaiting goToNextWord
-  const nextWord = TestWords.words.getCurrent();
+  const nextWord = TestWords.words.getCurrentText();
   const doesNextWordHaveTab = /^\t+/.test(nextWord);
   const isCurrentCharTab = nextWord[TestInput.input.current.length] === "\t";
 
diff --git a/frontend/src/ts/input/helpers/word-navigation.ts b/frontend/src/ts/input/helpers/word-navigation.ts
@@ -60,9 +60,9 @@ export async function goToNextWord({
   TestInput.pushBurstToHistory(burst);
   ret.lastBurst = burst;
 
-  PaceCaret.handleSpace(correctInsert, TestWords.words.getCurrent());
+  PaceCaret.handleSpace(correctInsert, TestWords.words.getCurrentText());
 
-  Funbox.toggleScript(TestWords.words.get(TestState.activeWordIndex + 1));
+  Funbox.toggleScript(TestWords.words.getText(TestState.activeWordIndex + 1));
 
   TestInput.input.pushHistory();
   TestInput.corrected.pushHistory();
@@ -111,7 +111,7 @@ export function goToPreviousWord(
   TestState.decreaseActiveWordIndex();
   TestInput.corrected.popHistory();
 
-  Funbox.toggleScript(TestWords.words.get(TestState.activeWordIndex));
+  Funbox.toggleScript(TestWords.words.getText(TestState.activeWordIndex));
 
   const nospaceEnabled = isFunboxActiveWithProperty("nospace");
 
diff --git a/frontend/src/ts/input/listeners/input.ts b/frontend/src/ts/input/listeners/input.ts
@@ -125,7 +125,7 @@ inputEl.addEventListener("input", async (event) => {
     const inputPlusComposition =
       TestInput.input.current + (CompositionState.getData() ?? "");
     const inputPlusCompositionIsCorrect =
-      TestWords.words.getCurrent() === inputPlusComposition;
+      TestWords.words.getCurrentText() === inputPlusComposition;
 
     // composition quick end
     // if the user typed the entire word correctly but is still in composition
diff --git a/frontend/src/ts/test/funbox/funbox-functions.ts b/frontend/src/ts/test/funbox/funbox-functions.ts
@@ -54,7 +54,7 @@ export type FunboxFunctions = {
 async function readAheadHandleKeydown(event: KeyboardEvent): Promise<void> {
   const inputCurrentChar = (TestInput.input.current ?? "").slice(-1);
   const wordCurrentChar = TestWords.words
-    .getCurrent()
+    .getCurrentText()
     .slice(TestInput.input.current.length - 1, TestInput.input.current.length);
   const isCorrect = inputCurrentChar === wordCurrentChar;
 
@@ -63,7 +63,7 @@ async function readAheadHandleKeydown(event: KeyboardEvent): Promise<void> {
     !isCorrect &&
     (TestInput.input.current !== "" ||
       TestInput.input.getHistory(TestState.activeWordIndex - 1) !==
-        TestWords.words.get(TestState.activeWordIndex - 1) ||
+        TestWords.words.getText(TestState.activeWordIndex - 1) ||
       Config.freedomMode)
   ) {
     qs("#words")?.addClass("read_ahead_disabled");
@@ -452,7 +452,9 @@ const list: Partial<Record<FunboxName, FunboxFunctions>> = {
         }
         setTimeout(() => {
           highlight(
-            TestWords.words.getCurrent().charAt(TestInput.input.current.length),
+            TestWords.words
+              .getCurrentText()
+              .charAt(TestInput.input.current.length),
           );
         }, 1);
       }
diff --git a/frontend/src/ts/test/pace-caret.ts b/frontend/src/ts/test/pace-caret.ts
@@ -195,7 +195,7 @@ function incrementLetterIndex(): void {
     settings.currentLetterIndex++;
     if (
       settings.currentLetterIndex >=
-      TestWords.words.get(settings.currentWordIndex).length + 1
+      TestWords.words.getText(settings.currentWordIndex).length + 1
     ) {
       //go to the next word
       settings.currentLetterIndex = 0;
@@ -208,7 +208,7 @@ function incrementLetterIndex(): void {
           if (settings.currentLetterIndex <= -2) {
             //go to the previous word
             settings.currentLetterIndex =
-              TestWords.words.get(settings.currentWordIndex - 1).length - 1;
+              TestWords.words.getText(settings.currentWordIndex - 1).length - 1;
             settings.currentWordIndex--;
           }
           settings.correction++;
@@ -218,7 +218,7 @@ function incrementLetterIndex(): void {
           settings.currentLetterIndex++;
           if (
             settings.currentLetterIndex >=
-            TestWords.words.get(settings.currentWordIndex).length
+            TestWords.words.getText(settings.currentWordIndex).length
           ) {
             //go to the next word
             settings.currentLetterIndex = 0;
diff --git a/frontend/src/ts/test/practise-words.ts b/frontend/src/ts/test/practise-words.ts
@@ -55,15 +55,15 @@ export function init(
   let sortableMissedBiwords: [string, string, number][] = [];
   if (missed === "biwords") {
     for (let i = 0; i < TestWords.words.length; i++) {
-      const missedWord = TestWords.words.get(i);
+      const missedWord = TestWords.words.getText(i);
       const missedWordCount = TestInput.missedWords[missedWord];
       if (missedWordCount !== undefined) {
         if (i === 0) {
           sortableMissedBiwords.push([missedWord, "", missedWordCount]);
         } else {
           sortableMissedBiwords.push([
             missedWord,
-            TestWords.words.get(i - 1),
+            TestWords.words.getText(i - 1),
             missedWordCount,
           ]);
         }
@@ -87,7 +87,7 @@ export function init(
   let sortableSlowWords: [string, number][] = [];
   if (slow) {
     const typedWords = TestWords.words
-      .get()
+      .getText()
       .slice(0, TestInput.input.getHistory().length - 1);
 
     sortableSlowWords = typedWords.map((e, i) => [
diff --git a/frontend/src/ts/test/test-logic.ts b/frontend/src/ts/test/test-logic.ts
@@ -582,12 +582,12 @@ async function init(): Promise<boolean> {
       Arrays.nthElementFromArray(
         // ignoring for now but this might need a different approach
         // oxlint-disable-next-line no-misused-spread
-        [...TestWords.words.getCurrent()],
+        [...TestWords.words.getCurrentText()],
         0,
       ) as string,
     );
   }
-  Funbox.toggleScript(TestWords.words.getCurrent());
+  Funbox.toggleScript(TestWords.words.getCurrentText());
   TestUI.setLigatures(allLigatures ?? language.ligatures ?? false);
 
   const isLanguageRTL = allRightToLeft ?? language.rightToLeft ?? false;
@@ -684,8 +684,8 @@ export async function addWord(): Promise<void> {
     const randomWord = await WordsGenerator.getNextWord(
       TestWords.words.length,
       bound,
-      TestWords.words.get(TestWords.words.length - 1),
-      TestWords.words.get(TestWords.words.length - 2),
+      TestWords.words.getText(TestWords.words.length - 1),
+      TestWords.words.getText(TestWords.words.length - 2),
     );
 
     TestWords.words.push(randomWord.word, randomWord.sectionIndex);
@@ -1139,7 +1139,7 @@ export async function finish(difficultyFailed = false): Promise<void> {
 
       const lastWordInputLength = history[wordIndex]?.length ?? 0;
 
-      if (lastWordInputLength < TestWords.words.get(wordIndex).length) {
+      if (lastWordInputLength < TestWords.words.getText(wordIndex).length) {
         historyLength--;
       }
 
@@ -1470,7 +1470,7 @@ configEvent.subscribe(({ key, newValue, nosave }) => {
           Arrays.nthElementFromArray(
             // ignoring for now but this might need a different approach
             // oxlint-disable-next-line no-misused-spread
-            [...TestWords.words.getCurrent()],
+            [...TestWords.words.getCurrentText()],
             0,
           ) as string,
         );
diff --git a/frontend/src/ts/test/test-stats.ts b/frontend/src/ts/test/test-stats.ts
@@ -275,7 +275,7 @@ function getTargetWords(): string[] {
     targetWords.push(
       Config.mode === "zen"
         ? TestInput.input.current
-        : TestWords.words.getCurrent(),
+        : TestWords.words.getCurrentText(),
     );
   }
 
diff --git a/frontend/src/ts/test/test-timer.ts b/frontend/src/ts/test/test-timer.ts
@@ -142,7 +142,9 @@ function layoutfluid(): void {
       if (Config.keymapMode === "next") {
         setTimeout(() => {
           highlight(
-            TestWords.words.getCurrent().charAt(TestInput.input.current.length),
+            TestWords.words
+              .getCurrentText()
+              .charAt(TestInput.input.current.length),
           );
         }, 1);
       }
diff --git a/frontend/src/ts/test/test-ui.ts b/frontend/src/ts/test/test-ui.ts
@@ -228,7 +228,7 @@ async function joinOverlappingHints(
   hintElements: HTMLCollection,
 ): Promise<void> {
   const [isWordRightToLeft] = Strings.isWordRightToLeft(
-    TestWords.words.getCurrent(),
+    TestWords.words.getCurrentText(),
     TestState.isLanguageRightToLeft,
     TestState.isDirectionReversed,
   );
@@ -502,7 +502,7 @@ function showWords(): void {
   } else {
     let wordsHTML = "";
     for (let i = 0; i < TestWords.words.length; i++) {
-      wordsHTML += buildWordHTML(TestWords.words.get(i), i);
+      wordsHTML += buildWordHTML(TestWords.words.getText(i), i);
     }
     wordsEl.setHtml(wordsHTML);
   }
@@ -739,7 +739,7 @@ export async function updateWordLetters({
     `test-ui.updateWordLetters.${wordIndex}`,
     async () => {
       pendingWordData.delete(wordIndex);
-      const currentWord = TestWords.words.get(wordIndex);
+      const currentWord = TestWords.words.getText(wordIndex);
       if (!currentWord && Config.mode !== "zen") return;
       let ret = "";
       const wordAtIndex = getWordElement(wordIndex);
@@ -1326,7 +1326,7 @@ async function loadWordsHistory(): Promise<boolean> {
   for (let i = 0; i < inputHistoryLength + 2; i++) {
     const input = TestInput.input.getHistory(i);
     const corrected = TestInput.corrected.getHistory(i);
-    const word = TestWords.words.get(i) ?? "";
+    const word = TestWords.words.getText(i) ?? "";
     const koreanRegex =
       /[\uac00-\ud7af]|[\u1100-\u11ff]|[\u3130-\u318f]|[\ua960-\ua97f]|[\ud7b0-\ud7ff]/;
     const containsKorean =
@@ -1751,7 +1751,7 @@ function afterAnyTestInput(
 
   if (Config.keymapMode === "next") {
     highlight(
-      TestWords.words.getCurrent().charAt(TestInput.input.current.length),
+      TestWords.words.getCurrentText().charAt(TestInput.input.current.length),
     );
   }
 
@@ -1955,7 +1955,7 @@ qs(".pageTest #copyWordsListButton")?.on("click", async () => {
     words = TestInput.input.getHistory().join(" ");
   } else {
     words = TestWords.words
-      .get()
+      .getText()
       .slice(0, TestInput.input.getHistory().length)
       .join(" ");
   }
diff --git a/frontend/src/ts/test/test-words.ts b/frontend/src/ts/test/test-words.ts
@@ -12,9 +12,9 @@ class Words {
     this.length = 0;
   }
 
-  get(i?: undefined, raw?: boolean): string[];
-  get(i: number, raw?: boolean): string;
-  get(i?: number, raw = false): string | string[] | undefined {
+  getText(i?: undefined, raw?: boolean): string[];
+  getText(i: number, raw?: boolean): string;
+  getText(i?: number, raw = false): string | string[] | undefined {
     if (i === undefined) {
       return this.list;
     } else {
@@ -25,7 +25,7 @@ class Words {
       }
     }
   }
-  getCurrent(): string {
+  getCurrentText(): string {
     return this.list[TestState.activeWordIndex] ?? "";
   }
   getLast(): string {
