feat(refactor): Migrate to ESLint 9 (#207)

Author: rossbulat

.eslintignore

@@ -2,12 +2,12 @@ version: 2
 
 updates:
   - package-ecosystem: npm
-    directory: "/"
+    directory: '/'
     schedule:
       interval: monthly
     open-pull-requests-limit: 30
 
   - package-ecosystem: github-actions
-    directory: "/"
+    directory: '/'
     schedule:
       interval: monthly

.eslintrc.json

@@ -1 +1,10 @@
-{"library/react-connect-kit":"1.10.0","library/react-polkicon":"2.1.0","library/utils":"1.2.0","library/hooks":"1.4.0","library/factories":"1.0.0","library/crypto":"1.0.0","library/extension-assets":"1.0.0","library/types":"1.0.0"}
+{
+  "library/react-connect-kit": "1.10.0",
+  "library/react-polkicon": "2.1.0",
+  "library/utils": "1.2.0",
+  "library/hooks": "1.4.0",
+  "library/factories": "1.0.0",
+  "library/crypto": "1.0.0",
+  "library/extension-assets": "1.0.0",
+  "library/types": "1.0.0"
+}

.github/dependabot.yml

@@ -1,57 +1,57 @@
 /* @license Copyright 2024 w3ux authors & contributors
 SPDX-License-Identifier: GPL-3.0-only */
 
+import {
+  PACKAGE_SOURCE_REQUIRED_FILES,
+  PACKAGE_SOURCE_REQUIRED_PROPERTIES,
+} from 'config'
 import {
   checkFilesExistInPackages,
   gePackageDirectory,
   getPackageJson,
   removePackageOutput,
-} from "../util";
-import {
-  PACKAGE_SOURCE_REQUIRED_FILES,
-  PACKAGE_SOURCE_REQUIRED_PROPERTIES,
-} from "config";
+} from '../util'
 
 export const prebuild = async (folder: string): Promise<boolean> => {
-  const libDirectory = gePackageDirectory(folder);
+  const libDirectory = gePackageDirectory(folder)
 
   // Check if required files exist.
   const filesExist = await checkFilesExistInPackages(
     libDirectory,
     PACKAGE_SOURCE_REQUIRED_FILES
-  );
+  )
 
   if (!filesExist) {
-    console.error(`❌ Some required files are missing in the source package.`);
-    return false;
+    console.error(`❌ Some required files are missing in the source package.`)
+    return false
   }
 
   // Get source package.json.
-  const sourcePackageJson = await getPackageJson(libDirectory);
+  const sourcePackageJson = await getPackageJson(libDirectory)
 
   // Get required properties from `package.json`.
   const requiredProperties = Object.entries(sourcePackageJson).filter(
     ([property]) => PACKAGE_SOURCE_REQUIRED_PROPERTIES.includes(property)
-  );
+  )
 
   // Check that all required properties were fetched.
   if (requiredProperties.length !== PACKAGE_SOURCE_REQUIRED_PROPERTIES.length) {
     console.error(
       `❌ Some required properties are missing in the source package.json.`
-    );
-    return false;
+    )
+    return false
   }
 
   // Remove package output directory if it exists.
   if (!(await removePackageOutput(libDirectory, false))) {
-    console.error(`❌ Failed to remove package output directory.`);
-    return false;
+    console.error(`❌ Failed to remove package output directory.`)
+    return false
   }
   // Remove build output directory if it exists.
   if (!(await removePackageOutput(libDirectory, true))) {
-    console.error(`❌ Failed to remove package build directory.`);
-    return false;
+    console.error(`❌ Failed to remove package build directory.`)
+    return false
   }
 
-  return true;
-};
+  return true
+}

.prettierrc.json

@@ -1,54 +1,54 @@
 /* @license Copyright 2024 w3ux authors & contributors
 SPDX-License-Identifier: GPL-3.0-only */
 
-import { PACKAGE_OUTPUT } from "config";
-import { prebuild } from "builders/common/prebuild";
+import { prebuild } from 'builders/common/prebuild'
 import {
   gePackageDirectory,
   generatePackageJson,
   removePackageOutput,
-} from "builders/util";
-import { promisify } from "util";
-import { exec } from "child_process";
+} from 'builders/util'
+import { exec } from 'child_process'
+import { PACKAGE_OUTPUT } from 'config'
+import { promisify } from 'util'
 
-const execPromisify = promisify(exec);
+const execPromisify = promisify(exec)
 
 export const build = async () => {
-  const folder = "crypto";
-  const libDirectory = gePackageDirectory(folder);
+  const folder = 'crypto'
+  const libDirectory = gePackageDirectory(folder)
 
   try {
     // Prebuild integrity checks.
     if (!(await prebuild(folder))) {
-      throw `Prebuild failed.`;
+      throw `Prebuild failed.`
     }
 
     // Call tsup command to build dist folder.
     try {
-      await execPromisify(`cd ../library/${folder} && pnpm build`);
+      await execPromisify(`cd ../library/${folder} && pnpm build`)
     } catch (e) {
-      throw `Failed to generate dist. ${e}`;
+      throw `Failed to generate dist. ${e}`
     }
 
     // Generate package.json.
     if (
       !(await generatePackageJson(
         libDirectory,
         `${libDirectory}/${PACKAGE_OUTPUT}`,
-        "tsup"
+        'tsup'
       ))
     ) {
-      throw `Failed to generate package.json file.`;
+      throw `Failed to generate package.json file.`
     }
 
-    console.log(`✅ Package successfully built.`);
+    console.log(`✅ Package successfully built.`)
   } catch (err) {
     // Handle on error.
-    console.error(`❌ Error occurred while building the package.`, err);
+    console.error(`❌ Error occurred while building the package.`, err)
 
     // Remove package output directory if it exists.
     if (!(await removePackageOutput(libDirectory, false))) {
-      console.error(`❌ Failed to remove package output directory.`);
+      console.error(`❌ Failed to remove package output directory.`)
     }
   }
-};
+}

.release-please-manifest.json

@@ -6,75 +6,75 @@ import {
   getLibraryDirectory,
   getTemplate,
   getWorkspaceDirectory,
-} from "builders/util";
-import { PACKAGE_SCOPE } from "config";
-import fs from "fs/promises";
-import { parse } from "yaml";
+} from 'builders/util'
+import { PACKAGE_SCOPE } from 'config'
+import fs from 'fs/promises'
+import { parse } from 'yaml'
 
 export const build = async () => {
   try {
-    const packages = await getPackages();
+    const packages = await getPackages()
 
     // Open file to get directory header.
     // ----------------------------------
-    let data = await getTemplate("directory");
+    let data = await getTemplate('directory')
 
     for (const pkg of packages) {
       // Create package directory title and description.
       // -----------------------------------------------
-      data += formatDirectoryHeaders(pkg);
+      data += formatDirectoryHeaders(pkg)
 
       // Format directory data from package `index.yml`.
       // -----------------------------------------------
-      const { directory } = await getSourceIndexYml(pkg);
+      const { directory } = await getSourceIndexYml(pkg)
 
       // Append the directory entries.
       // -----------------------------
-      data += formatDirectoryEntry(directory);
+      data += formatDirectoryEntry(directory)
     }
 
     // Write to docs/README.md.
     // ------------------------
-    await fs.writeFile(`${getWorkspaceDirectory()}/README.md`, data);
+    await fs.writeFile(`${getWorkspaceDirectory()}/README.md`, data)
 
-    console.log("✅ Generated directory successfully.");
+    console.log('✅ Generated directory successfully.')
   } catch (err) {
-    console.error(`❌ Error occurred while building directory.`, err);
+    console.error(`❌ Error occurred while building directory.`, err)
   }
-};
+}
 
 // Gets the list of packges.
 export const getPackages = async () => {
-  const packages = await fs.readdir(getLibraryDirectory());
-  return packages;
-};
+  const packages = await fs.readdir(getLibraryDirectory())
+  return packages
+}
 
 // Format the package introduction data in the README file.
 export const formatDirectoryHeaders = (pkg: string) =>
-  "\n#### `" +
+  '\n#### `' +
   formatNpmPackageName(pkg) +
-  "`  [[npm](https://www.npmjs.com/package/" +
+  '`  [[npm](https://www.npmjs.com/package/' +
   formatNpmPackageName(pkg) +
-  ")" +
-  " |  [source](https://github.com/w3ux/w3ux-library/tree/main/library/" +
+  ')' +
+  ' |  [source](https://github.com/w3ux/w3ux-library/tree/main/library/' +
   pkg +
-  ")]\n";
+  ')]\n'
 
 // Format the package name to include the package scope.
 export const formatNpmPackageName = (name: string) =>
-  `@${PACKAGE_SCOPE}/${name.replace(/-source$/, "")}`;
+  `@${PACKAGE_SCOPE}/${name.replace(/-source$/, '')}`
 
 // Get the source index.yml file for a package.
 export const getSourceIndexYml = async (name: string) =>
   parse(
-    await fs.readFile(`${gePackageDirectory(name)}/packageInfo.yml`, "utf-8")
-  );
+    await fs.readFile(`${gePackageDirectory(name)}/packageInfo.yml`, 'utf-8')
+  )
 
 // Format the package content data in the README file.
 export const formatDirectoryEntry = (
   directory: { name: string; description: string }[]
 ) =>
   directory.reduce(
-    (str: string, { description }) => str + "\n" + description + "\n",
-    ""
-  );
+    (str: string, { description }) => str + '\n' + description + '\n',
+    ''
+  )