chore: update to eslint 9

Author: fedeericodl

.eslintignore

@@ -3,6 +3,9 @@
 // WARNING: any imported files need to be added to files in package.json
 
 import asar from "@electron/asar";
+import chalk from "chalk";
+import esbuild from "esbuild";
+import { sassPlugin } from "esbuild-sass-plugin";
 import {
   copyFileSync,
   cpSync,
@@ -12,18 +15,16 @@ import {
   rmSync,
   writeFileSync,
 } from "fs";
-import esbuild from "esbuild";
 import path from "path";
+import type { PluginManifest, ThemeManifest } from "src/types";
 import updateNotifier from "update-notifier";
-import yargs, { ArgumentsCamelCase } from "yargs";
-import { hideBin } from "yargs/helpers";
-import chalk from "chalk";
+import { fileURLToPath, pathToFileURL } from "url";
 import WebSocket from "ws";
-import { release } from "./release.mjs";
+import yargs, { type ArgumentsCamelCase } from "yargs";
+import { hideBin } from "yargs/helpers";
 import { logBuildPlugin } from "../src/util.mjs";
-import { sassPlugin } from "esbuild-sass-plugin";
-import { fileURLToPath, pathToFileURL } from "url";
-import { AddonType, getAddonFolder, isMonoRepo, selectAddon } from "./mono.mjs";
+import { type AddonType, getAddonFolder, isMonoRepo, selectAddon } from "./mono.mjs";
+import { release } from "./release.mjs";
 
 interface BaseArgs {
   watch?: boolean;
@@ -92,6 +93,7 @@ function tryPort(port: number): Promise<WebSocket | undefined> {
         return;
       }
 
+      // eslint-disable-next-line @typescript-eslint/no-base-to-string
       const message = JSON.parse(data.toString());
       if (message.evt !== "READY") {
         return;
@@ -185,7 +187,7 @@ async function reload(id: string): Promise<void> {
 
   reloading = true;
 
-  await new Promise((resolve) => {
+  await new Promise<void>((resolve) => {
     /**
      *
      * @param {import('ws').RawData} data
@@ -201,7 +203,8 @@ async function reload(id: string): Promise<void> {
       reloading = false;
       if (reloadAgain) {
         reloadAgain = false;
-        resolve(await reload(id));
+        await reload(id);
+        resolve();
         return;
       }
 
@@ -257,7 +260,7 @@ async function bundleAddon(
   if (!existsSync("bundle")) {
     mkdirSync("bundle");
   }
-  asar.createPackage(distPath, `${outputName}.asar`);
+  await asar.createPackage(distPath, `${outputName}.asar`);
   copyFileSync(`${distPath}/manifest.json`, `${outputName}.json`);
 
   console.log(`Bundled ${manifest.name}`);
@@ -273,7 +276,7 @@ async function handleContexts(
         await context.watch();
       } else {
         await context.rebuild().catch(() => process.exit(1));
-        context.dispose();
+        await context.dispose();
       }
     }),
   );
@@ -304,15 +307,15 @@ function buildAddons(buildFn: (args: Args) => Promise<void>, args: Args, type: A
   const addons = getAddonFolder(type);
 
   addons.forEach((addon) => {
-    buildFn({ ...args, addon });
+    void buildFn({ ...args, addon });
   });
 }
 
 async function buildPlugin({ watch, noInstall, production, noReload, addon }: Args): Promise<void> {
   const manifestPath = addon
     ? path.join(directory, "plugins", addon, "manifest.json")
     : path.join(directory, "manifest.json");
-  const manifest = JSON.parse(readFileSync(manifestPath.toString(), "utf-8"));
+  const manifest: PluginManifest = JSON.parse(readFileSync(manifestPath.toString(), "utf-8"));
   const distPath = addon ? `dist/${manifest.id}` : "dist";
   const folderPath = addon ? path.join(directory, "plugins", addon) : directory;
 
@@ -405,7 +408,7 @@ async function buildPlugin({ watch, noInstall, production, noReload, addon }: Ar
       esbuild.context(
         overwrites({
           ...common,
-          entryPoints: [path.join(folderPath, manifest.renderer)],
+          entryPoints: [path.join(folderPath, manifest.renderer!)],
           outfile: `${distPath}/renderer.js`,
         }),
       ),
@@ -419,7 +422,7 @@ async function buildPlugin({ watch, noInstall, production, noReload, addon }: Ar
       esbuild.context(
         overwrites({
           ...common,
-          entryPoints: [path.join(folderPath, manifest.plaintextPatches)],
+          entryPoints: [path.join(folderPath, manifest.plaintextPatches!)],
           outfile: `${distPath}/plaintextPatches.js`,
         }),
       ),
@@ -442,7 +445,7 @@ async function buildTheme({ watch, noInstall, production, noReload, addon }: Arg
   const manifestPath = addon
     ? path.join(directory, "themes", addon, "manifest.json")
     : "manifest.json";
-  const manifest = JSON.parse(readFileSync(manifestPath.toString(), "utf-8"));
+  const manifest: ThemeManifest = JSON.parse(readFileSync(manifestPath.toString(), "utf-8"));
   const distPath = addon ? `dist/${manifest.id}` : "dist";
   const folderPath = addon ? path.join(directory, "themes", addon) : directory;
 
@@ -568,16 +571,20 @@ const { argv } = yargs(hideBin(process.argv))
     },
     async (argv) => {
       if (argv.addon === "plugin") {
-        if (argv.all && isMonoRepo) return buildAddons(buildPlugin, argv, "plugins");
-        else {
+        if (argv.all && isMonoRepo) {
+          buildAddons(buildPlugin, argv, "plugins");
+          return;
+        } else {
           const plugin = isMonoRepo ? await selectAddon("plugins") : undefined;
-          buildPlugin({ ...argv, addon: plugin?.name });
+          await buildPlugin({ ...argv, addon: plugin?.name });
         }
       } else if (argv.addon === "theme") {
-        if (argv.all && isMonoRepo) return buildAddons(buildTheme, argv, "themes");
-        else {
+        if (argv.all && isMonoRepo) {
+          buildAddons(buildTheme, argv, "themes");
+          return;
+        } else {
           const theme = isMonoRepo ? await selectAddon("themes") : undefined;
-          buildTheme({ ...argv, addon: theme?.name });
+          await buildTheme({ ...argv, addon: theme?.name });
         }
       } else {
         console.log("Invalid addon type.");
@@ -596,23 +603,28 @@ const { argv } = yargs(hideBin(process.argv))
     },
     async (argv) => {
       if (argv.addon === "plugin") {
-        if (argv.all && isMonoRepo) return bundleAddons(buildPlugin, "plugins");
-        else {
+        if (argv.all && isMonoRepo) {
+          bundleAddons(buildPlugin, "plugins");
+          return;
+        } else {
           const addon = isMonoRepo ? await selectAddon("plugins") : undefined;
-          bundleAddon(buildPlugin, addon?.name, "plugins");
+          await bundleAddon(buildPlugin, addon?.name, "plugins");
         }
       } else if (argv.addon === "theme") {
-        if (argv.all && isMonoRepo) return bundleAddons(buildTheme, "themes");
-        else {
+        if (argv.all && isMonoRepo) {
+          bundleAddons(buildTheme, "themes");
+          return;
+        } else {
           const addon = isMonoRepo ? await selectAddon("themes") : undefined;
-          bundleAddon(buildTheme, addon?.name, "themes");
+          await bundleAddon(buildTheme, addon?.name, "themes");
         }
       } else {
         console.log("Invalid addon type.");
       }
       sendUpdateNotification();
     },
   )
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   .command("release", "Interactively release a new version of an addon", () => {}, release)
   .parserConfiguration({
     "boolean-negation": false,

.eslintrc.yml

@@ -2,8 +2,8 @@
 
 import { existsSync, readdirSync } from "fs";
 import path from "path";
-import { directory } from "./index.mjs";
 import prompts from "prompts";
+import { directory } from "./index.mjs";
 import { onCancel } from "./release.mjs";
 
 export const isMonoRepo =
@@ -27,7 +27,7 @@ interface SelectedAddon {
 
 export async function selectAddon(type: AddonType | "all"): Promise<SelectedAddon> {
   if (type !== "all") {
-    const folder = getAddonFolder(type as AddonType);
+    const folder = getAddonFolder(type);
 
     const { addon } = await prompts(
       {

bin/index.mts

@@ -1,11 +1,12 @@
 // WARNING: any imported files need to be added to files in package.json
 
+import chalk from "chalk";
+import { execSync } from "child_process";
 import { existsSync, readFileSync, writeFileSync } from "fs";
 import path from "path";
 import prompts from "prompts";
 import semver from "semver";
-import chalk from "chalk";
-import { execSync } from "child_process";
+import type { AnyAddonManifest } from "src/types";
 import { isMonoRepo, selectAddon } from "./mono.mjs";
 
 /**
@@ -94,7 +95,7 @@ export async function release(): Promise<void> {
     process.exit(1);
   }
   const manifestText = readFileSync(manifestPath, "utf8");
-  let manifest;
+  let manifest: AnyAddonManifest;
   try {
     manifest = JSON.parse(manifestText);
   } catch {
@@ -119,7 +120,7 @@ export async function release(): Promise<void> {
   // Prompt for version
 
   const { version } = manifest;
-  let nextVersion;
+  let nextVersion: string | null = null;
 
   const isValidSemver = Boolean(semver.valid(version));
   if (isValidSemver) {
@@ -170,7 +171,7 @@ export async function release(): Promise<void> {
     ));
   }
 
-  nextVersion = nextVersion.trim();
+  nextVersion = nextVersion?.trim() ?? "";
   const isNewValidSemver = Boolean(semver.valid(nextVersion));
   if (isValidSemver) {
     // If the existing version is not semver, don't bother with semver checks
@@ -180,7 +181,7 @@ export async function release(): Promise<void> {
       }
       const cleaned = semver.clean(nextVersion);
       if (cleaned !== nextVersion) {
-        let { clean } = await prompts({
+        const { clean } = await prompts({
           type: "confirm",
           name: "clean",
           message: `Convert ${nextVersion} to cleaned version ${cleaned}?`,
@@ -194,7 +195,7 @@ export async function release(): Promise<void> {
   }
 
   // Update manifest.json and package.json
-  manifest.version = nextVersion;
+  manifest.version = nextVersion!;
   if (packageJson) packageJson.version = nextVersion;
 
   // Write manifest.json and package.json (indent with 2 spaces and keep trailing newline)
@@ -234,7 +235,7 @@ export async function release(): Promise<void> {
       initial: isMonoRepo
         ? `v${nextVersion}-${manifest.name.replace(" ", "_")}`
         : `v${nextVersion}`,
-      validate: (value) => {
+      validate: (value: string) => {
         if (!value.trim()) return "Tag name is required";
 
         if (existingTags.includes(value)) return `Tag ${value} already exists`;