Upgrade and fix up linting (Biome and tsc).

lgarron · lgarron · commit e101aa2886c6 · 2025-07-23T18:26:10.000-07:00
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -24,5 +24,6 @@ jobs:
         with:
           bun-version: latest
       - run: make setup
-      - run: make test
+      - run: make lint-biome
+      - run: make lint-tsc
       - run: make clean
diff --git a/Makefile b/Makefile
@@ -11,9 +11,16 @@ format: setup
 	bun x @biomejs/biome check --write
 
 .PHONY: lint
-lint: setup
+lint: lint-biome lint-tsc
+
+.PHONY: lint-biome
+lint-biome: setup
 	bun x @biomejs/biome check
 
+.PHONY: lint-tsc
+lint-tsc: setup
+	bun x tsc --noEmit --project .
+
 .PHONY: setup
 setup:
 	bun install --no-save
diff --git a/biome.json b/biome.json
@@ -1,7 +1,7 @@
 {
   "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
   "files": {
-    "ignore": ["./dist", "./package.json"]
+    "includes": ["**", "!dist", "!package.json"]
   },
   "formatter": {
     "indentStyle": "space",
diff --git a/bun.lock b/bun.lock
@@ -18,6 +18,7 @@
       "devDependencies": {
         "@biomejs/biome": "^2.1.2",
         "@cubing/deploy": "^0.2.2",
+        "@cubing/dev-config": "^0.3.6",
         "@types/chai": "^5.2.2",
         "@types/mocha": "^10.0.10",
         "barely-a-dev-server": "^0.8.1",
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.1.2",
     "@cubing/deploy": "^0.2.2",
+    "@cubing/dev-config": "^0.3.6",
     "@types/chai": "^5.2.2",
     "@types/mocha": "^10.0.10",
     "barely-a-dev-server": "^0.8.1",
diff --git a/src/timer.cubing.net/app/TimerApp.ts b/src/timer.cubing.net/app/TimerApp.ts
@@ -6,7 +6,7 @@ import type {
   AttemptDataWithIDAndRev,
 } from "../results/AttemptData";
 import { Stats } from "../results/Stats";
-import { TimerSession, allDocsResponseToTimes } from "../results/TimerSession";
+import { TimerSession } from "../results/TimerSession";
 import { Controller } from "../timing/Controller";
 import type { Milliseconds } from "../timing/Timer";
 import { ScrambleView, type ScrambleWithEvent } from "../ui/ScrambleView";
@@ -36,27 +36,24 @@ const favicons: { [s: string]: string } = {
 // TODO: Import this from "./scramble-worker"
 export type ScrambleID = number;
 
-const STORED_EVENT_TIMEOUT_MS = 15 * 60 * 1000;
 const LATEST_AMOUNT = 100;
 
 export class TimerApp {
   private scrambleView: ScrambleView;
   private statsView: StatsView;
   private domElement: HTMLElement;
-  private currentEvent: EventID;
+  private currentEvent: EventID = "333"; // TODO: are there any issues with a default value here?
   private controller: Controller;
-  private awaitedScrambleID: ScrambleID;
-  private currentScramble: ScrambleWithEvent;
+  private awaitedScrambleID: ScrambleID | undefined;
+  private currentScramble: ScrambleWithEvent | undefined;
   private session = new TimerSession();
-  private remoteDB: PouchDB.Database<AttemptData>;
+  // private remoteDB: PouchDB.Database<AttemptData>;
 
-  private cachedBest: number | null = null;
-  private cachedWorst: number | null = null;
   constructor() {
     this.session.startSync(this.onSyncChange.bind(this));
 
     this.scrambleView = new ScrambleView(this);
-    this.statsView = new StatsView(() => this.currentEvent);
+    this.statsView = new StatsView();
     this.domElement = <HTMLElement>document.getElementById("timer-app");
 
     this.enableOffline();
@@ -103,18 +100,21 @@ export class TimerApp {
     // }, 750);
   }
 
-  private async getTimes(): Promise<Milliseconds[]> {
-    const docs0 = await this.session.mostRecentAttemptsForEvent(
-      this.currentEvent,
-      LATEST_AMOUNT,
-    );
-    console.log(docs0);
-    const docs = await this.session.db.allDocs({
-      // descending: true,
-      include_docs: true,
-    });
-    return allDocsResponseToTimes(docs);
-  }
+  // private async getTimes(): Promise<Milliseconds[]> {
+  //   if (!this.currentEvent) {
+  //     return [];
+  //   }
+  //   const docs0 = await this.session.mostRecentAttemptsForEvent(
+  //     this.currentEvent,
+  //     LATEST_AMOUNT,
+  //   );
+  //   console.log(docs0);
+  //   const docs = await this.session.db.allDocs({
+  //     // descending: true,
+  //     include_docs: true,
+  //   });
+  //   return allDocsResponseToTimes(docs);
+  // }
 
   // Prevent a timer tap from scrolling the whole page on touch screens.
   private onTouchMove(e: Event) {
@@ -127,7 +127,7 @@ export class TimerApp {
   }
 
   private enableOffline() {
-    const infoBar = document.getElementById("update-bar");
+    // const infoBar = document.getElementById("update-bar");
   }
 
   private setInitialEvent() {
@@ -238,8 +238,8 @@ export class TimerApp {
       event: this.currentEvent,
       scramble: this.currentScramble?.scramble?.toString() ?? "",
     };
-    if (localStorage.pouchDBDeviceName) {
-      attemptData.device = localStorage.pouchDBDeviceName;
+    if (localStorage["pouchDBDeviceName"]) {
+      attemptData.device = localStorage["pouchDBDeviceName"];
     }
     await this.session.addNewAttempt(attemptData);
   }
@@ -253,7 +253,7 @@ export class TimerApp {
     ).docs.reverse();
   }
 
-  async updateDisplayStats(assumeAttemptAppended: boolean = false) {
+  async updateDisplayStats(_assumeAttemptAppended: boolean = false) {
     const attempts = await this.latest();
     const times = attempts.map((attempt) => attempt.totalResultMs);
     const numAttempts = (await this.session.db.info()).doc_count - 1;
diff --git a/src/timer.cubing.net/app/localStorageSettings.ts b/src/timer.cubing.net/app/localStorageSettings.ts
@@ -1,15 +1,15 @@
 export function hideScrambleDisplay(): boolean {
-  return localStorage.hideScrambleDisplay === "true";
+  return localStorage["hideScrambleDisplay"] === "true";
 }
 
 export function setHideScrambleDisplay(hide: boolean): void {
-  localStorage.hideScrambleDisplay = hide ? "true" : "false";
+  localStorage["hideScrambleDisplay"] = hide ? "true" : "false";
 }
 
 export function preferHarmonicMean(): boolean {
-  return localStorage.preferHarmonicMean === "true";
+  return localStorage["preferHarmonicMean"] === "true";
 }
 
 export function setPreferHarmonicMean(hide: boolean): void {
-  localStorage.preferHarmonicMean = hide ? "true" : "false";
+  localStorage["preferHarmonicMean"] = hide ? "true" : "false";
 }
diff --git a/src/timer.cubing.net/index.ts b/src/timer.cubing.net/index.ts
@@ -1,9 +1,7 @@
 import "cubing/twisty";
-import { TimerApp } from "./app/TimerApp";
 
 import { Workbox } from "workbox-window";
-
-const SW_CACHE_FILE = "./sw.js";
+import { TimerApp } from "./app/TimerApp";
 
 // biome-ignore lint/suspicious/noExplicitAny: Just a quick global assignment.
 (window as any).app = new TimerApp();
@@ -12,7 +10,7 @@ const SW_CACHE_FILE = "./sw.js";
 if (location.hostname.split(".").slice(-1)[0] !== "localhost") {
   window.addEventListener("load", () => {
     const wb = new Workbox(new URL("./sw.js", import.meta.url).href);
-    wb.addEventListener("waiting", (event) => {
+    wb.addEventListener("waiting", (_event) => {
       wb.messageSkipWaiting();
     });
     wb.register();
diff --git a/src/timer.cubing.net/resources/vendor/twizzle-link.ts b/src/timer.cubing.net/resources/vendor/twizzle-link.ts
@@ -9,9 +9,7 @@ export function twizzleLink(
   alg: Alg | string | undefined,
   title?: string,
 ) {
-  // biome-ignore lint/style/noParameterAssign: Old code pattern
   setup = new Alg(setup);
-  // biome-ignore lint/style/noParameterAssign: Old code pattern
   alg = new Alg(alg);
   const url = new URL("https://alpha.twizzle.net/edit/");
 
diff --git a/src/timer.cubing.net/results/AttemptData.ts b/src/timer.cubing.net/results/AttemptData.ts
@@ -1,5 +1,5 @@
 import type { EventID } from "../app/events";
-import type { UUID, newDateUUID } from "./uuid";
+import type { UUID } from "./uuid";
 
 type AttemptUUID = UUID;
 type AlgString = string;
diff --git a/src/timer.cubing.net/results/TimerSession.ts b/src/timer.cubing.net/results/TimerSession.ts
@@ -26,7 +26,7 @@ export function allDocsResponseToTimes(
 
 export class TimerSession {
   public db: PouchDB.Database<AttemptData>;
-  public remoteDB: PouchDB.Database<AttemptData>;
+  public remoteDB: PouchDB.Database<AttemptData> | undefined;
   constructor(name: string = "session") {
     this.db = new PouchDB(`session_${name}`);
     this.db.createIndex({
@@ -37,7 +37,7 @@ export class TimerSession {
   startSync(
     onSyncChange: (change: PouchDB.Replication.SyncResult<AttemptData>) => void,
   ): void {
-    if (!localStorage.pouchDBUsername || !localStorage.pouchDBPassword) {
+    if (!localStorage["pouchDBUsername"] || !localStorage["pouchDBPassword"]) {
       console.info("No CouchDB user!");
       return;
     }
@@ -48,9 +48,9 @@ export class TimerSession {
     // - Validate username/password.
     // - auth using e.g. cookies
     const url = new URL("https://couchdb.api.cubing.net/");
-    url.username = localStorage.pouchDBUsername;
-    url.password = localStorage.pouchDBPassword;
-    url.pathname = `results-${localStorage.pouchDBUsername}`;
+    url.username = localStorage["pouchDBUsername"];
+    url.password = localStorage["pouchDBPassword"];
+    url.pathname = `results-${localStorage["pouchDBUsername"]}`;
 
     this.remoteDB = new PouchDB(url.toString());
     this.db
diff --git a/src/timer.cubing.net/results/uuid.ts b/src/timer.cubing.net/results/uuid.ts
@@ -1,6 +1,6 @@
 export type UUID = string;
 
-function bufferToHex(buffer: ArrayBuffer): string {
+function bufferToHex(buffer: ArrayBuffer | Uint8Array): string {
   const uint8Array = new Uint8Array(buffer);
   return Array.prototype.slice
     .call(uint8Array)
diff --git a/src/timer.cubing.net/timing/Controller.ts b/src/timer.cubing.net/timing/Controller.ts
@@ -16,6 +16,7 @@ type TransitionMap = Partial<Record<State, State>>;
 
 export class Controller {
   private timer: Timer;
+  // @ts-ignore: This is initialized but TypeScript is not powerful enough to tell.
   private state: State;
   constructor(
     private domElement: HTMLElement,
diff --git a/src/timer.cubing.net/timing/Timer.ts b/src/timer.cubing.net/timing/Timer.ts
@@ -3,7 +3,7 @@ export type Milliseconds = number;
 export class Timer {
   private running: boolean = false;
   private animFrameBound: () => void;
-  private startTime: number;
+  private startTime: number = Math.floor(performance.now());
   constructor(private currentTimeCallback: (t: Milliseconds) => void) {
     this.animFrameBound = this.animFrame.bind(this);
   }
diff --git a/src/timer.cubing.net/ui/ScrambleView.ts b/src/timer.cubing.net/ui/ScrambleView.ts
@@ -2,8 +2,8 @@
 import { Alg } from "cubing/alg";
 import { eventInfo } from "cubing/puzzles";
 import type { TwistyPlayer } from "cubing/twisty";
-import type { TimerApp } from "../app/TimerApp";
 import { type EventID, eventOrder, modifiedEventName } from "../app/events";
+import type { TimerApp } from "../app/TimerApp";
 import { removeClassesStartingWith } from "./ui-util";
 
 export type ScrambleWithEvent = {
@@ -12,7 +12,6 @@ export type ScrambleWithEvent = {
 };
 
 export class ScrambleView {
-  private scrambleElement: HTMLElement;
   private eventSelectDropdown: HTMLSelectElement;
   private cubingIcon: HTMLElement;
   private scrambleText = document.querySelector(
@@ -22,9 +21,10 @@ export class ScrambleView {
   private twistyPlayer = document.querySelector(
     "#scramble-display twisty-player",
   ) as TwistyPlayer;
-  private optionElementsByEventID: { [s: string]: HTMLOptionElement };
+  private optionElementsByEventID:
+    | { [s: string]: HTMLOptionElement }
+    | undefined;
   constructor(private timerApp: TimerApp) {
-    this.scrambleElement = <HTMLElement>document.getElementById("scramble-bar");
     this.eventSelectDropdown = <HTMLSelectElement>(
       document.getElementById("event-select-dropdown")
     );
@@ -68,7 +68,7 @@ export class ScrambleView {
     this.cubingIcon.classList.add(`unofficial-${iconEventID}`);
     if (
       this.eventSelectDropdown.value !== eventID &&
-      this.optionElementsByEventID[eventID]
+      this.optionElementsByEventID?.[eventID]
     ) {
       this.optionElementsByEventID[eventID].selected = true;
     }
diff --git a/src/timer.cubing.net/ui/StatsView.ts b/src/timer.cubing.net/ui/StatsView.ts
@@ -1,4 +1,5 @@
-import type { EventID } from "../app/events";
+/** biome-ignore-all lint/complexity/useLiteralKeys: Known Biome limitation. */
+
 import type { AttemptDataWithIDAndRev } from "../results/AttemptData";
 // import {ScrambleID} from "./scramble-worker"
 import { trForAttempt } from "./results-table";
@@ -21,7 +22,7 @@ export class StatsView {
   private statsDropdown: HTMLSelectElement;
   private elems: { [s: string]: HTMLOptionElement };
   private sidebarElems: { [s: string]: HTMLOptionElement };
-  constructor(private getCurrentEvent: () => EventID) {
+  constructor() {
     this.statsDropdown = <HTMLSelectElement>(
       document.getElementById("stats-dropdown")
     );
@@ -97,31 +98,28 @@ export class StatsView {
       this.elems[storedCurrentStat].selected = true;
     }
 
-    this.statsDropdown.addEventListener(
-      "change",
-      function () {
-        localStorage.setItem("current-stat", this.statsDropdown.value);
-        this.statsDropdown.blur();
-      }.bind(this),
-    );
+    this.statsDropdown.addEventListener("change", () => {
+      localStorage.setItem("current-stat", this.statsDropdown.value);
+      this.statsDropdown.blur();
+    });
   }
 
   setStats(stats: FormattedStats, attempts: AttemptDataWithIDAndRev[]) {
-    const maxLen = Math.max(
-      ...[
-        `μ3: ${stats.mean3}`,
-        `⌀5: ${stats.avg5}`,
-        `⌀12: ${stats.avg12}`,
-        `⌀100: ${stats.avg100}`,
-        `ℏ3: ${stats.rate3}`,
-        `ℏ5: ${stats.rate5}`,
-        `ℏ12: ${stats.rate12}`,
-        `ℏ100: ${stats.rate100}`,
-        `best: ${stats.best}`,
-        `worst: ${stats.worst}`,
-        `DB size: ${stats.numAttempts}`,
-      ].map((s) => s.length),
-    );
+    // const maxLen = Math.max(
+    //   ...[
+    //     `μ3: ${stats.mean3}`,
+    //     `⌀5: ${stats.avg5}`,
+    //     `⌀12: ${stats.avg12}`,
+    //     `⌀100: ${stats.avg100}`,
+    //     `ℏ3: ${stats.rate3}`,
+    //     `ℏ5: ${stats.rate5}`,
+    //     `ℏ12: ${stats.rate12}`,
+    //     `ℏ100: ${stats.rate100}`,
+    //     `best: ${stats.best}`,
+    //     `worst: ${stats.worst}`,
+    //     `DB size: ${stats.numAttempts}`,
+    //   ].map((s) => s.length),
+    // );
     function setStat(elem: HTMLOptionElement, s: string): void {
       elem.textContent = "";
       elem.appendChild(document.createTextNode(s));
diff --git a/src/timer.cubing.net/ui/TimeView.ts b/src/timer.cubing.net/ui/TimeView.ts
@@ -1,4 +1,5 @@
 import { Stats } from "../results/Stats";
+
 const THIN_CHARS = "1:";
 
 export class View {
diff --git a/src/timer.cubing.net/ui/results-page.ts b/src/timer.cubing.net/ui/results-page.ts
diff --git a/src/timer.cubing.net/ui/results-table.ts b/src/timer.cubing.net/ui/results-table.ts
diff --git a/src/timer.cubing.net/ui/style.css b/src/timer.cubing.net/ui/style.css
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tsconfig.jsonc b/tsconfig.jsonc

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "./node_modules/@biomejs/biome/configuration_schema.json",`
`3`	`3`	`"files": {`
`4`		`- "ignore": ["./dist", "./package.json"]`
	`4`	`+ "includes": ["**", "!dist", "!package.json"]`
`5`	`5`	`},`
`6`	`6`	`"formatter": {`
`7`	`7`	`"indentStyle": "space",`
Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`export function hideScrambleDisplay(): boolean {`
`2`		`- return localStorage.hideScrambleDisplay === "true";`
	`2`	`+ return localStorage["hideScrambleDisplay"] === "true";`
`3`	`3`	`}`
`4`	`4`
`5`	`5`	`export function setHideScrambleDisplay(hide: boolean): void {`
`6`		`- localStorage.hideScrambleDisplay = hide ? "true" : "false";`
	`6`	`+ localStorage["hideScrambleDisplay"] = hide ? "true" : "false";`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`export function preferHarmonicMean(): boolean {`
`10`		`- return localStorage.preferHarmonicMean === "true";`
	`10`	`+ return localStorage["preferHarmonicMean"] === "true";`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`export function setPreferHarmonicMean(hide: boolean): void {`
`14`		`- localStorage.preferHarmonicMean = hide ? "true" : "false";`
	`14`	`+ localStorage["preferHarmonicMean"] = hide ? "true" : "false";`
`15`	`15`	`}`