web: update to ESLint 9 (goauthentik#10812)

* web: update to ESLint 9

ESLint 9 has been out for awhile now, and all of the plug-ins that we use have caught up, so it is
time to bite the bullet and upgrade.  This commit:

- upgrades to ESLint 9, and upgrades all associated plugins
- Replaces the `.eslintrc` and `.eslintignore` files with the new, "flat" configuration file,
  "eslint.config.mjs".
- Places the previous "precommit" and "nightmare" rules in `./scripts/eslint.precommit.mjs` and
  `./scripts/eslint.nightmare.mjs`, respectively
- Replaces the scripted wrappers for eslint (`eslint`, `eslint-precommit`) with a single executable
  that takes the arguments `--precommit`, which applies a stricter set of rules, and `--nightmare`,
  which applies an even more terrifyingly strict set of rules.
- Provides the scripted wrapper `./scripts/eslint.mjs` so that eslint can be run from `bun`, if one
  so chooses.
- Fixes *all* of the lint `eslint.config.mjs` now finds, including removing all of the `eslint`
  styling rules and overrides because Eslint now proudly leaves that entirely up to Prettier.

To shut Dependabot up about ESLint.

* Added explanation for no-console removal.

* web: did not need the old and unmaintained nightmare mode; it can be configured directly.

web/build.mjs

@@ -16,15 +16,13 @@ try {
     authentikProjectRoot = execFileSync("git", ["rev-parse", "--show-toplevel"], {
         encoding: "utf8",
     }).replace("\n", "");
-} catch (exc) {
+} catch (_exc) {
     // We probably don't have a .git folder, which could happen in container builds
 }
 const rootPackage = JSON.parse(fs.readFileSync(path.join(authentikProjectRoot, "./package.json")));
 
-// eslint-disable-next-line no-undef
 const isProdBuild = process.env.NODE_ENV === "production";
 
-// eslint-disable-next-line no-undef
 const apiBasePath = process.env.AK_API_BASE_PATH || "";
 
 const envGitHashKey = "GIT_BUILD_HASH";
@@ -35,10 +33,11 @@ const definitions = {
     "process.env.AK_API_BASE_PATH": JSON.stringify(apiBasePath),
 };
 
-// All is magic is just to make sure the assets are copied into the right places. This is a very stripped down version
-// of what the rollup-copy-plugin does, without any of the features we don't use, and using globSync instead of globby
-// since we already had globSync lying around thanks to Typescript. If there's a third argument in an array entry, it's
-// used to replace the internal path before concatenating it all together as the destination target.
+// All is magic is just to make sure the assets are copied into the right places. This is a very
+// stripped down version of what the rollup-copy-plugin does, without any of the features we don't
+// use, and using globSync instead of globby since we already had globSync lying around thanks to
+// Typescript. If there's a third argument in an array entry, it's used to replace the internal path
+// before concatenating it all together as the destination target.
 
 const otherFiles = [
     ["node_modules/@patternfly/patternfly/patternfly.min.css", "."],
@@ -67,8 +66,8 @@ for (const [source, rawdest, strip] of otherFiles) {
     }
 }
 
-// This starts the definitions used for esbuild: Our targets, our arguments, the function for running a build, and three
-// options for building: watching, building, and building the proxy.
+// This starts the definitions used for esbuild: Our targets, our arguments, the function for
+// running a build, and three options for building: watching, building, and building the proxy.
 // Ordered by largest to smallest interface to build even faster
 const interfaces = [
     ["admin/AdminInterface/AdminInterface.ts", "admin"],
@@ -104,7 +103,6 @@ function getVersion() {
 
 async function buildOneSource(source, dest) {
     const DIST = path.join(__dirname, "./dist", dest);
-    // eslint-disable-next-line no-console
     console.log(`[${new Date(Date.now()).toISOString()}] Starting build for target ${source}`);
 
     try {
@@ -116,7 +114,6 @@ async function buildOneSource(source, dest) {
             outdir: DIST,
         });
         const end = Date.now();
-        // eslint-disable-next-line no-console
         console.log(
             `[${new Date(end).toISOString()}] Finished build for target ${source} in ${Date.now() - start}ms`,
         );
@@ -135,14 +132,12 @@ function debouncedBuild() {
         clearTimeout(timeoutId);
     }
     timeoutId = setTimeout(() => {
-        // eslint-disable-next-line no-console
         console.clear();
         buildAuthentik(interfaces);
     }, 250);
 }
 
 if (process.argv.length > 2 && (process.argv[2] === "-h" || process.argv[2] === "--help")) {
-    // eslint-disable-next-line no-console
     console.log(`Build the authentikUI
 
 options:
@@ -154,7 +149,6 @@ options:
 }
 
 if (process.argv.length > 2 && (process.argv[2] === "-w" || process.argv[2] === "--watch")) {
-    // eslint-disable-next-line no-console
     console.log("Watching ./src for changes");
     chokidar.watch("./src").on("all", (event, path) => {
         if (!["add", "change", "unlink"].includes(event)) {

web/eslint.config.mjs

@@ -0,0 +1,80 @@
+import eslint from "@eslint/js";
+import tsparser from "@typescript-eslint/parser";
+import litconf from "eslint-plugin-lit";
+import wcconf from "eslint-plugin-wc";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default [
+    // You would not believe how much this change has frustrated users: ["if an ignores key is used
+    // without any other keys in the configuration object, then the patterns act as global
+    // ignores"](https://eslint.org/docs/latest/use/configure/ignore)
+    {
+        ignores: [
+            "dist/",
+            // don't ever lint node_modules
+            "node_modules/",
+            ".storybook/*",
+            // don't lint build output (make sure it's set to your correct build folder name)
+            // don't lint nyc coverage output
+            "coverage/",
+            "src/locale-codes.ts",
+            "storybook-static/",
+            "src/locales/",
+        ],
+    },
+    eslint.configs.recommended,
+    wcconf.configs["flat/recommended"],
+    litconf.configs["flat/recommended"],
+    ...tseslint.configs.recommended,
+    {
+        languageOptions: {
+            parser: tsparser,
+            parserOptions: {
+                ecmaVersion: 12,
+                sourceType: "module",
+            },
+        },
+        files: ["src/**"],
+        rules: {
+            "no-unused-vars": "off",
+            "no-console": ["error", { allow: ["debug", "warn", "error"] }],
+            "@typescript-eslint/ban-ts-comment": "off",
+            "@typescript-eslint/no-unused-vars": [
+                "error",
+                {
+                    argsIgnorePattern: "^_",
+                    varsIgnorePattern: "^_",
+                    caughtErrorsIgnorePattern: "^_",
+                },
+            ],
+        },
+    },
+    {
+        languageOptions: {
+            parser: tsparser,
+            parserOptions: {
+                ecmaVersion: 12,
+                sourceType: "module",
+            },
+            globals: {
+                ...globals.nodeBuiltin,
+            },
+        },
+        files: ["scripts/*.mjs", "*.ts", "*.mjs"],
+        rules: {
+            "no-unused-vars": "off",
+            // We WANT our scripts to output to the console!
+            "no-console": "off",
+            "@typescript-eslint/ban-ts-comment": "off",
+            "@typescript-eslint/no-unused-vars": [
+                "error",
+                {
+                    argsIgnorePattern: "^_",
+                    varsIgnorePattern: "^_",
+                    caughtErrorsIgnorePattern: "^_",
+                },
+            ],
+        },
+    },
+];