refactor: enable ban-ts-comment rule

Miodec · Miodec · commit 0b05b3c2fdb7 · 2025-04-16T19:15:30.000+02:00
diff --git a/backend/.oxlintrc.json b/backend/.oxlintrc.json
@@ -9,7 +9,8 @@
       "plugins": ["jest", "vitest"],
       "rules": {
         "no-explicit-any": "allow",
-        "explicit-function-return-type": "off"
+        "explicit-function-return-type": "off",
+        "ban-ts-comment": "off"
       }
     }
   ]
diff --git a/backend/src/services/weekly-xp-leaderboard.ts b/backend/src/services/weekly-xp-leaderboard.ts
@@ -196,8 +196,6 @@ export class WeeklyXpLeaderboard {
     // eslint-disable-next-line @typescript-eslint/no-unused-expressions
     connection.set;
 
-    // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-    // @ts-ignore
     const [[, rank], [, totalXp], [, _count], [, result]] = (await connection
       .multi()
       .zrevrank(weeklyXpLeaderboardScoresKey, uid)
@@ -207,7 +205,8 @@ export class WeeklyXpLeaderboard {
       .exec()) as [
       [null, number | null],
       [null, string | null],
-      [null, number | null]
+      [null, number | null],
+      [null, string | null]
     ];
 
     if (rank === null) {
diff --git a/frontend/.oxlintrc.json b/frontend/.oxlintrc.json
@@ -10,7 +10,8 @@
         "no-explicit-any": "allow",
         "explicit-function-return-type": "off",
         "no-array-for-each": "off",
-        "eqeqeq": "off"
+        "eqeqeq": "off",
+        "ban-ts-comment": "off"
       }
     }
   ]
diff --git a/frontend/__tests__/setup-tests.ts b/frontend/__tests__/setup-tests.ts
@@ -1,7 +1,7 @@
 import $ from "jquery";
-// @ts-ignore
+//@ts-expect-error add to globl
 global["$"] = $;
-// @ts-ignore
+//@ts-expect-error add to globl
 global["jQuery"] = $;
 
 vi.mock("../src/ts/constants/env-config", () => ({
diff --git a/frontend/src/ts/config.ts b/frontend/src/ts/config.ts
@@ -1453,7 +1453,7 @@ function setThemes(
   if (!isConfigValueValid("themes", theme, ConfigSchemas.ThemeNameSchema))
     return false;
 
-  //@ts-expect-error
+  //@ts-expect-error config used to have 9
   if (customThemeColors.length === 9) {
     //color missing
     if (customState) {
@@ -1539,7 +1539,7 @@ export function setCustomThemeColors(
   nosave?: boolean
 ): boolean {
   // migrate existing configs missing sub alt color
-  // @ts-expect-error
+  // @ts-expect-error legacy configs
   if (colors.length === 9) {
     //color missing
     Notifications.add(
@@ -1931,8 +1931,8 @@ export function setCustomBackgroundFilter(
   array: ConfigSchemas.CustomBackgroundFilter,
   nosave?: boolean
 ): boolean {
-  //convert existing configs using five values down to four
-  //@ts-expect-error
+  // @ts-expect-error this used to be 5
+  // need to convert existing configs using five values down to four
   if (array.length === 5) {
     array = [array[0], array[1], array[2], array[3]];
   }
diff --git a/frontend/src/ts/constants/env-config.ts b/frontend/src/ts/constants/env-config.ts
@@ -10,15 +10,15 @@ type Config = {
 
 //@ts-expect-error these get replaced by vite
 const backendUrl = BACKEND_URL;
-// @ts-expect-error
+// @ts-expect-error ---
 const isDevelopment = IS_DEVELOPMENT;
-// @ts-expect-error
+// @ts-expect-error ---
 const clientVersion = CLIENT_VERSION;
-// @ts-expect-error
+// @ts-expect-error ---
 const recaptchaSiteKey = RECAPTCHA_SITE_KEY;
-// @ts-expect-error
+// @ts-expect-error ---
 const quickLoginEmail = QUICK_LOGIN_EMAIL;
-// @ts-expect-error
+// @ts-expect-error ---
 const quickLoginPassword = QUICK_LOGIN_PASSWORD;
 
 export const envConfig: Config = {
diff --git a/frontend/src/ts/controllers/ad-controller.ts b/frontend/src/ts/controllers/ad-controller.ts
@@ -143,15 +143,15 @@ export async function checkAdblock(): Promise<void> {
   return new Promise((resolve) => {
     if (choice === "eg") {
       if (adBlock === undefined) {
-        //@ts-expect-error
+        //@ts-expect-error 3rd party ad code
         if (window.egAdPack === undefined) {
           adBlock = true;
         } else {
           adBlock = false;
         }
       }
     } else if (choice === "pw") {
-      //@ts-expect-error
+      //@ts-expect-error 3rd party ad code
       if (window.ramp === undefined) {
         adBlock = true;
       }
@@ -169,13 +169,13 @@ export async function checkCookieblocker(): Promise<void> {
         return;
       }
 
-      //@ts-expect-error
+      //@ts-expect-error 3rd party ad code
       if (window.__tcfapi === undefined) {
         cookieBlocker = true;
         resolve();
         return;
       }
-      //@ts-expect-error
+      //@ts-expect-error 3rd party ad code
       // eslint-disable-next-line @typescript-eslint/no-unsafe-call
       window.__tcfapi("getTCData", 2, (tcData, success) => {
         if (success as boolean) {
@@ -269,13 +269,13 @@ export function updateFooterAndVerticalAds(visible: boolean): void {
 
 export function showConsentPopup(): void {
   if (choice === "eg") {
-    //@ts-expect-error
+    //@ts-expect-error 3rd party ad code, doesnt have types
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     window.__tcfapi("displayConsentUi", 2, function () {
       //
     });
   } else {
-    //@ts-expect-error
+    //@ts-expect-error 3rd party ad code, doesnt have types
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     ramp.showCmpModal();
   }
@@ -322,7 +322,7 @@ $(document).ready(() => {
 });
 
 window.onerror = function (error): void {
-  //@ts-expect-error
+  //@ts-expect-error ---
   if (choice === "eg") {
     if (typeof error === "string" && error.startsWith("EG APS")) {
       $("#ad-result-wrapper .iconAndText").addClass("withLeft");
diff --git a/frontend/src/ts/controllers/captcha-controller.ts b/frontend/src/ts/controllers/captcha-controller.ts
@@ -15,7 +15,7 @@ export function render(
     return;
   }
 
-  //@ts-expect-error
+  //@ts-expect-error 3rd party code, no types
   const widgetId = grecaptcha.render(element, {
     sitekey: siteKey,
     callback,
@@ -29,7 +29,7 @@ export function reset(id: string): void {
     return;
   }
 
-  //@ts-expect-error
+  //@ts-expect-error 3rd party code, no types
   // eslint-disable-next-line @typescript-eslint/no-unsafe-call
   grecaptcha.reset(captchas[id]);
 }
@@ -39,7 +39,7 @@ export function getResponse(id: string): string {
     return "";
   }
 
-  //@ts-expect-error
+  //@ts-expect-error 3rd party code, no types
   // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
   return grecaptcha.getResponse(captchas[id]);
 }
diff --git a/frontend/src/ts/controllers/chart-controller.ts b/frontend/src/ts/controllers/chart-controller.ts
@@ -87,14 +87,14 @@ class ChartWithUpdateColors<
   }
 
   getDataset(id: DatasetIds): ChartDataset<TType, TData> {
-    //@ts-expect-error
+    //@ts-expect-error its too difficult to figure out these types, but this works
     return this.data.datasets?.find((x) => x.yAxisID === id);
   }
 
   getScale(
     id: DatasetIds extends never ? never : "x" | DatasetIds
   ): DatasetIds extends never ? never : CartesianScaleOptions {
-    //@ts-expect-error
+    //@ts-expect-error its too difficult to figure out these types, but this works
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access
     return this.options.scales[id];
   }
@@ -1155,7 +1155,7 @@ async function updateColors<
 
   const gridcolor = blendTwoHexColors(bgcolor, subaltcolor, 0.75);
 
-  //@ts-expect-error
+  //@ts-expect-error its too difficult to figure out these types, but this works
   chart.data.datasets[0].borderColor = (ctx): string => {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     const isPb = ctx.raw?.isPb as boolean;
@@ -1177,7 +1177,7 @@ async function updateColors<
   if (chart?.data?.datasets[0]?.type === undefined) {
     if (chart.config.type === "line") {
       dataset0.pointBackgroundColor = (ctx): string => {
-        //@ts-expect-error
+        //@ts-expect-error not sure why raw comes out to unknown, but this works
         const isPb = ctx.raw?.isPb as boolean;
         const color = isPb ? textcolor : maincolor;
         return color;
diff --git a/frontend/src/ts/controllers/eg-ad-controller.ts b/frontend/src/ts/controllers/eg-ad-controller.ts
@@ -15,7 +15,7 @@ export function init(): void {
 
 export function renderResult(widerThanBreakpoint: boolean): void {
   if (widerThanBreakpoint) {
-    //@ts-expect-error
+    //@ts-expect-error 3rd party ad code
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     window.egAps.render([
       "ad-result",
@@ -24,7 +24,7 @@ export function renderResult(widerThanBreakpoint: boolean): void {
       "ad-footer",
     ]);
   } else {
-    //@ts-expect-error
+    //@ts-expect-error 3rd party ad code
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     window.egAps.render([
       "ad-result-small",
@@ -37,7 +37,7 @@ export function renderResult(widerThanBreakpoint: boolean): void {
 
 export function reinstate(): boolean {
   try {
-    //@ts-expect-error
+    //@ts-expect-error 3rd party ad code
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call
     window.egAps.reinstate();
     return true;
@@ -48,7 +48,7 @@ export function reinstate(): boolean {
 }
 
 export async function refreshVisible(): Promise<void> {
-  ////@ts-expect-error
+  ////@ts-expect-error 3rd party ad code
   // const adDivs = Object.keys(window.egAdPack.gptAdSlots);
   // const visibleAdDivs = [];
   // for (let i = 0; i < adDivs.length; i++) {
@@ -63,6 +63,6 @@ export async function refreshVisible(): Promise<void> {
   //     visibleAdDivs.push(adDivs[i]);
   //   }
   // }
-  // //@ts-ignore
+  // //@ts-expect-error 3rd party ad code
   // window.egAps.refreshAds(visibleAdDivs);
 }
diff --git a/frontend/src/ts/controllers/input-controller.ts b/frontend/src/ts/controllers/input-controller.ts
@@ -94,11 +94,11 @@ function updateUI(): void {
 
           //@ts-expect-error really cant be bothered fixing all these issues - its gonna get caught anyway
           const koChar: string =
-            //@ts-expect-error
+            //@ts-expect-error ---
             koCurrWord[inputGroupLength][inputCharLength] ??
-            //@ts-expect-error
+            //@ts-expect-error ---
             koCurrWord[koCurrInput.length][
-              //@ts-expect-error
+              //@ts-expect-error ---
               inputCharLength - koCurrWord[inputGroupLength].length
             ];
 
diff --git a/frontend/src/ts/controllers/page-controller.ts b/frontend/src/ts/controllers/page-controller.ts
@@ -95,7 +95,7 @@ export async function change(
           await previousPage?.afterHide();
           await nextPage?.beforeShow({
             params: options.params,
-            //@ts-expect-error
+            // @ts-expect-error for the future (i think)
             data: options.data,
           });
         }
diff --git a/frontend/src/ts/controllers/pw-ad-controller.ts b/frontend/src/ts/controllers/pw-ad-controller.ts
@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
-//@ts-nocheck
+// oxlint-disable ban-ts-comment
+//@ts-nocheck too many errors from 3rd party ad code
 
 import Config from "../config";
 import * as ActivePage from "../states/active-page";
diff --git a/frontend/src/ts/controllers/sound-controller.ts b/frontend/src/ts/controllers/sound-controller.ts
@@ -398,10 +398,8 @@ export async function previewClick(val: string): Promise<void> {
   const clickSoundIds = Object.keys(safeClickSounds);
   if (!clickSoundIds.includes(val)) return;
 
-  //@ts-expect-error
-  safeClickSounds[val][0].sounds[0].seek(0);
-  //@ts-expect-error
-  safeClickSounds[val][0].sounds[0].play();
+  safeClickSounds?.[val]?.[0]?.sounds[0]?.seek(0);
+  safeClickSounds?.[val]?.[0]?.sounds[0]?.play();
 }
 
 export async function previewError(val: string): Promise<void> {
diff --git a/frontend/src/ts/firebase.ts b/frontend/src/ts/firebase.ts
@@ -2,7 +2,8 @@
 import { FirebaseApp, initializeApp } from "firebase/app";
 import { getAuth, Auth as AuthType, User } from "firebase/auth";
 // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-//@ts-ignore
+// oxlint-disable ban-ts-comment
+// @ts-ignore as far as i remember this is for CI
 // eslint-disable-next-line import/no-unresolved
 import { firebaseConfig } from "./constants/firebase-config";
 import * as Notifications from "./elements/notifications";
diff --git a/frontend/src/ts/index.ts b/frontend/src/ts/index.ts
@@ -48,7 +48,7 @@ import { getDevOptionsModal } from "./utils/async-modules";
 
 function addToGlobal(items: Record<string, unknown>): void {
   for (const [name, item] of Object.entries(items)) {
-    //@ts-expect-error
+    //@ts-expect-error dev
     window[name] = item;
   }
 }
diff --git a/frontend/src/ts/pages/account.ts b/frontend/src/ts/pages/account.ts
@@ -1103,7 +1103,7 @@ function sortAndRefreshHistory(
       }
     }
 
-    //@ts-expect-error
+    // @ts-expect-error temp
     temp.push(filteredResults[idx]);
     parsedIndexes.push(idx);
   }
@@ -1289,7 +1289,7 @@ $(".pageAccount .group.presetFilterButtons").on(
 );
 
 $(".pageAccount .content .group.aboveHistory .exportCSV").on("click", () => {
-  //@ts-expect-error
+  //@ts-expect-error dont really wanna figure out the types here but it works
   void Misc.downloadResultsCSV(filteredResults);
 });
 
diff --git a/frontend/src/ts/pages/leaderboards.ts b/frontend/src/ts/pages/leaderboards.ts
@@ -316,7 +316,7 @@ async function requestData(update = false): Promise<void> {
     state.pageSize = dataResponse.body.data.pageSize;
 
     if (state.type === "daily") {
-      //@ts-ignore not sure why this is causing errors when it's clearly defined in the schema
+      //@ts-expect-error not sure why this is causing errors when it's clearly defined in the schema
       // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       state.minWpm = dataResponse.body.data.minWpm;
     }
diff --git a/frontend/src/ts/pages/settings.ts b/frontend/src/ts/pages/settings.ts
@@ -441,7 +441,7 @@ function reset(): void {
   $(".pageSettings .section[data-config-name='funbox'] .buttons").empty();
   $(".pageSettings .section[data-config-name='fontFamily'] .buttons").empty();
   for (const select of document.querySelectorAll(".pageSettings select")) {
-    //@ts-expect-error
+    //@ts-expect-error slim gets added to the html element but ts doesnt know about it
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
     select?.slim?.destroy?.();
   }
diff --git a/frontend/src/ts/popups/video-ad-popup.ts b/frontend/src/ts/popups/video-ad-popup.ts
@@ -39,7 +39,7 @@ export async function show(): Promise<void> {
       .css("opacity", 0)
       .removeClass("hidden")
       .animate({ opacity: 1 }, 125, () => {
-        //@ts-expect-error
+        //@ts-expect-error 3rd party ad code
         window.dataLayer.push({ event: "EG_Video" });
       });
   }
diff --git a/frontend/src/ts/ready.ts b/frontend/src/ts/ready.ts
@@ -4,7 +4,7 @@ import * as MerchBanner from "./elements/merch-banner";
 import * as CookiesModal from "./modals/cookies";
 import * as ConnectionState from "./states/connection";
 import * as AccountButton from "./elements/account-button";
-//@ts-expect-error
+//@ts-expect-error no types for this package
 import Konami from "konami";
 import * as ServerConfiguration from "./ape/server-configuration";
 import { getActiveFunboxesWithFunction } from "./test/funbox/list";
diff --git a/frontend/src/ts/test/test-logic.ts b/frontend/src/ts/test/test-logic.ts
@@ -86,7 +86,7 @@ export function clearNotSignedInResult(): void {
 export function setNotSignedInUidAndHash(uid: string): void {
   if (notSignedInLastResult === null) return;
   notSignedInLastResult.uid = uid;
-  //@ts-expect-error
+  //@ts-expect-error really need to delete this
   delete notSignedInLastResult.hash;
   notSignedInLastResult.hash = objectHash(notSignedInLastResult);
 }
diff --git a/frontend/src/ts/test/test-stats.ts b/frontend/src/ts/test/test-stats.ts
diff --git a/frontend/src/ts/utils/config.ts b/frontend/src/ts/utils/config.ts
diff --git a/frontend/src/ts/utils/date-and-time.ts b/frontend/src/ts/utils/date-and-time.ts
diff --git a/frontend/src/ts/utils/misc.ts b/frontend/src/ts/utils/misc.ts
diff --git a/packages/oxlint-config/index.json b/packages/oxlint-config/index.json

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,8 @@`
`9`	`9`	`"plugins": ["jest", "vitest"],`
`10`	`10`	`"rules": {`
`11`	`11`	`"no-explicit-any": "allow",`
`12`		`- "explicit-function-return-type": "off"`
	`12`	`+ "explicit-function-return-type": "off",`
	`13`	`+ "ban-ts-comment": "off"`
`13`	`14`	`}`
`14`	`15`	`}`
`15`	`16`	`]`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,8 @@`
`10`	`10`	`"no-explicit-any": "allow",`
`11`	`11`	`"explicit-function-return-type": "off",`
`12`	`12`	`"no-array-for-each": "off",`
`13`		`- "eqeqeq": "off"`
	`13`	`+ "eqeqeq": "off",`
	`14`	`+ "ban-ts-comment": "off"`
`14`	`15`	`}`
`15`	`16`	`}`
`16`	`17`	`]`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export function render(`
`15`	`15`	`return;`
`16`	`16`	`}`
`17`	`17`
`18`		`- //@ts-expect-error`
	`18`	`+ //@ts-expect-error 3rd party code, no types`
`19`	`19`	`const widgetId = grecaptcha.render(element, {`
`20`	`20`	`sitekey: siteKey,`
`21`	`21`	`callback,`
`@@ -29,7 +29,7 @@ export function reset(id: string): void {`
`29`	`29`	`return;`
`30`	`30`	`}`
`31`	`31`
`32`		`- //@ts-expect-error`
	`32`	`+ //@ts-expect-error 3rd party code, no types`
`33`	`33`	`// eslint-disable-next-line @typescript-eslint/no-unsafe-call`
`34`	`34`	`grecaptcha.reset(captchas[id]);`
`35`	`35`	`}`
`@@ -39,7 +39,7 @@ export function getResponse(id: string): string {`
`39`	`39`	`return "";`
`40`	`40`	`}`
`41`	`41`
`42`		`- //@ts-expect-error`
	`42`	`+ //@ts-expect-error 3rd party code, no types`
`43`	`43`	`// eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call`
`44`	`44`	`return grecaptcha.getResponse(captchas[id]);`
`45`	`45`	`}`