Upgrade to ESLint 9 (#2481)

Author: benjie

.changeset/chilly-windows-like.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-graphile-export": patch
+---
+
+🚨 Now uses a flat config for compatibility with ESLint v9.

.github/workflows/lint.yml

@@ -24,8 +24,12 @@ jobs:
           cache: "yarn"
 
       - run: yarn --immutable
-      - name: Compile eslint-plugin-graphile-export
-        run: yarn workspaces foreach --parallel --topological --recursive --from eslint-plugin-graphile-export run prepack
+
+      - name: "Build"
+        run: yarn build
+
+      - name: "Prepack"
+        run: yarn workspaces foreach --parallel --topological --all run prepack
 
       - name: "Lint Code"
         run: yarn eslint .

.lintignore

@@ -7,6 +7,7 @@ node_modules/
 /postgraphile/postgraphile/assets/
 /postgraphile/postgraphile/src/assets/
 /postgraphile/postgraphile/exported-schema.js
+/postgraphile/postgraphile/exported-schema.mjs
 /postgraphile/postgraphile/exported-schema.webpacked.js
 /grafast/ruru/bundle/ruru.min.js
 /grafast/ruru/bundle/ruru.min.js.LICENSE.txt

.eslintrc.js eslint.config.mjs.eslintrc.js renamed to eslint.config.mjs

@@ -1,43 +1,76 @@
-module.exports = {
-  parser: "@babel/eslint-parser",
-  parserOptions: {
+// @ts-check
+import babelParser from "@babel/eslint-parser";
+import js from "@eslint/js";
+import tsParser from "@typescript-eslint/parser";
+import { defineConfig, globalIgnores } from "eslint/config";
+import prettier from "eslint-config-prettier";
+import graphileExport from "eslint-plugin-graphile-export";
+import graphql from "eslint-plugin-graphql";
+import importPlugin from "eslint-plugin-import";
+import jest from "eslint-plugin-jest";
+import react from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+import tsdoc from "eslint-plugin-tsdoc";
+import fs from "fs";
+import globals from "globals";
+import path from "path";
+import tseslint from "typescript-eslint";
+
+const __dirname = import.meta.dirname;
+
+const globalIgnoresFromFile = fs
+  .readFileSync(path.resolve(__dirname, ".lintignore"), "utf8")
+  .split("\n")
+  .map((line) => line.trim())
+  .filter((line) => line && !line.startsWith("#"))
+  .map((line) => {
+    let text = line;
+    text = text.startsWith("/") ? text.substring(1) : `**/${text}`;
+    text = text.endsWith("/") ? text + "**" : text;
+    return text;
+  });
+
+/** @type {import('@eslint/config-helpers').ConfigWithExtends} */
+const config = {
+  linterOptions: {
+    reportUnusedDisableDirectives: false,
+  },
+  languageOptions: {
+    parser: babelParser,
     sourceType: "module",
-    ecmaFeatures: {
-      jsx: true,
+
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+
+    globals: {
+      jasmine: false,
+      ...globals.jest,
+      ...globals.node,
     },
   },
-  globals: {
-    jasmine: false,
-  },
-  env: {
-    jest: true,
-    node: true,
-    es6: true,
-  },
+
   settings: {
     react: {
       version: "detect",
     },
+    "import/resolver": {
+      node: true,
+      typescript: true,
+    },
+  },
+
+  plugins: {
+    jest,
+    graphql,
+    tsdoc,
+    "simple-import-sort": simpleImportSort,
+    react,
+    "react-hooks": reactHooks,
   },
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    //'plugin:@typescript-eslint/recommended-requiring-type-checking',
-    "plugin:import/errors",
-    "plugin:import/typescript",
-    "plugin:graphile-export/recommended",
-    "prettier",
-  ],
-  plugins: [
-    "jest",
-    "graphql",
-    "tsdoc",
-    "simple-import-sort",
-    "import",
-    "graphile-export",
-    "react-hooks",
-  ],
 
   rules: {
     "@typescript-eslint/ban-ts-comment": "off",
@@ -49,7 +82,8 @@ module.exports = {
     "@typescript-eslint/no-namespace": "off",
     "@typescript-eslint/no-use-before-define": "off",
     "@typescript-eslint/no-var-requires": "off",
-    "@typescript-eslint/consistent-type-imports": "error",
+    // This needs full type-checking now (apparently?)
+    "@typescript-eslint/consistent-type-imports": "off",
     "no-confusing-arrow": 0,
     "no-else-return": 0,
     "no-underscore-dangle": 0,
@@ -58,6 +92,10 @@ module.exports = {
     "jest/no-focused-tests": 2,
     "jest/no-identical-title": 2,
     "tsdoc/syntax": 2,
+    "@typescript-eslint/no-empty-object-type": [
+      "error",
+      { allowInterfaces: "always" },
+    ],
 
     // Rules that we should enable:
     "@typescript-eslint/no-inferrable-types": "warn",
@@ -71,6 +109,7 @@ module.exports = {
       {
         argsIgnorePattern: "^_",
         varsIgnorePattern: "^_",
+        caughtErrors: "none",
         args: "after-used",
         ignoreRestSiblings: true,
       },
@@ -85,7 +124,12 @@ module.exports = {
     "sort-imports": "off",
     "import/order": "off",
 
-    "import/extensions": ["error", "ignorePackages"],
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      // TODO: fix this properly, rather than turning off 'ts'/'tsx'
+      { ts: "never", tsx: "never" },
+    ],
     "import/no-deprecated": "warn",
 
     // Apply has been more optimised than spread, use whatever feels right.
@@ -95,6 +139,15 @@ module.exports = {
     "no-duplicate-imports": "off",
     "import/no-duplicates": "error",
   },
+};
+
+/**
+ * This object only exists to make our new eslint.config.js look more like the
+ * old .eslintrc.js
+ *
+ * @type {{overrides: ReadonlyArray<import('@eslint/config-helpers').ConfigWithExtends>}}
+ */
+const oldConfig = {
   overrides: [
     // Rules for core plugins
     {
@@ -154,8 +207,12 @@ module.exports = {
 
     // Rules for TypeScript only
     {
-      files: ["*.ts", "*.tsx"],
-      parser: "@typescript-eslint/parser",
+      files: ["**/*.ts", "**/*.tsx", "**/*.mts", "**/*.mtsx"],
+
+      languageOptions: {
+        parser: tsParser,
+      },
+
       rules: {
         "no-dupe-class-members": "off",
         "no-undef": "off",
@@ -166,21 +223,26 @@ module.exports = {
 
     // Rules for JavaScript only
     {
-      files: ["*.js", "*.jsx", "*.mjs", "*.cjs"],
+      files: ["**/*.js", "**/*.jsx", "**/*.mjs", "**/*.cjs"],
       rules: {
         "tsdoc/syntax": "off",
         "import/extensions": "off",
+        "@typescript-eslint/no-require-imports": "off",
       },
     },
 
     // Stricter rules for source code
     {
       files: ["*/*/src/**/*.ts", "*/*/src/**/*.tsx"],
-      parser: "@typescript-eslint/parser",
-      parserOptions: {
-        project: true,
+      languageOptions: {
+        parser: tsParser,
+        parserOptions: {
+          project: true,
+        },
+      },
+      rules: {
+        "@typescript-eslint/consistent-type-imports": "error",
       },
-      rules: {},
     },
 
     // Rules for tests only
@@ -190,6 +252,7 @@ module.exports = {
         // Disable these to enable faster test writing
         "prefer-const": "off",
         "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-expressions": "off",
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/explicit-function-return-type": "off",
 
@@ -205,8 +268,9 @@ module.exports = {
         "grafast/ruru/src/**/*.tsx",
         "**/website/src/**",
       ],
-      extends: ["plugin:react/recommended"],
       rules: {
+        ...react.configs.recommended.rules,
+        ...reactHooks.configs.recommended.rules,
         "react-hooks/rules-of-hooks": "error",
         "react-hooks/exhaustive-deps": [
           "warn",
@@ -243,13 +307,14 @@ module.exports = {
       files: ["**/website/**"],
       rules: {
         "import/no-unresolved": "off",
+        "simple-import-sort/imports": "off",
       },
     },
 
     // Don't use Node.js builtins
     {
       files: ["grafast/grafast/src/**", "utils/graphile-config/src/**"],
-      excludedFiles: ["utils/graphile-config/src/loadConfig.ts"],
+      ignores: ["utils/graphile-config/src/loadConfig.ts"],
       rules: {
         "@typescript-eslint/no-restricted-imports": [
           "error",
@@ -297,3 +362,24 @@ module.exports = {
     },
   ],
 };
+
+export default defineConfig([
+  //"eslint:recommended",
+  js.configs.recommended,
+  // "plugin:@typescript-eslint/eslint-recommended",
+  //"plugin:@typescript-eslint/recommended",
+  tseslint.configs.recommended,
+  //'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  // ...tseslint.configs.recommendedTypeChecked, // requires parserOptions.project
+  // "plugin:import/errors",
+  importPlugin.flatConfigs.errors,
+  // "plugin:import/typescript",
+  { rules: importPlugin.flatConfigs.typescript.rules },
+  // "plugin:graphile-export/recommended",
+  graphileExport.configs.recommended,
+  //"prettier",
+  prettier, // not a plugin, just a config object
+  config,
+  ...oldConfig.overrides,
+  globalIgnores(globalIgnoresFromFile),
+]);

grafast/dataplan-pg/scripts/runExampleSchema.mjs

@@ -10,6 +10,7 @@ import { resolvePreset } from "graphile-config";
 import { isAsyncIterable } from "iterall";
 import JSON5 from "json5";
 
+// eslint-disable-next-line import/no-unresolved
 import { schema } from "./exampleSchemaExport.mjs";
 
 const databaseName = "graphilecrystaltest";
@@ -87,7 +88,7 @@ async function runTestQuery(basePath) {
     await promise;
     const sortPayloads = (payload1, payload2) => {
       const ONE_AFTER_TWO = 1;
-      const ONE_BEFORE_TWO = -1;
+      // const ONE_BEFORE_TWO = -1;
       if (!payload1.path) {
         return 0;
       }

grafast/dataplan-pg/src/adaptors/pg.ts

@@ -145,7 +145,7 @@ function newNodePostgresPgClient(
                 text: `rollback to savepoint tx${txLevel === 0 ? "" : txLevel}`,
               });
             }
-          } catch (e2) {
+          } catch (_e2) {
             console.error(`Error occurred whilst rolling back: ${e}`);
           }
           throw e;
@@ -710,7 +710,7 @@ export class PgSubscriber<
             await client.query(`UNLISTEN ${client.escapeIdentifier(topic)}`);
             this.subscribedTopics.delete(topic);
           }
-        } catch (e) {
+        } catch (_e) {
           // ignore
         }
         client.release();

grafast/dataplan-pg/src/datasource.ts

@@ -1388,7 +1388,7 @@ function validateRelations(registry: PgRegistry<any, any, any, any>): void {
   }
 }
 
-// eslint-disable-next-line @typescript-eslint/ban-types
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export function makeRegistryBuilder(): PgRegistryBuilder<{}, {}, {}, {}> {
   const registryConfig: PgRegistryConfig<any, any, any> = {
     pgExecutors: Object.create(null),

grafast/dataplan-pg/src/examples/exampleSchema.ts

@@ -1710,7 +1710,7 @@ export function makeExampleSchema(
   >;
 
   const {
-    pgCodecs: { union__entity: unionEntityCodec },
+    pgCodecs: { union__entity: _unionEntityCodec },
     pgResources: {
       messages: messageResource,
       users: userResource,
@@ -2860,7 +2860,7 @@ export function makeExampleSchema(
 
   const entityUnion = EXPORTABLE(
     (lambda) =>
-      <TCodec extends typeof unionEntityCodec>(
+      <TCodec extends typeof _unionEntityCodec>(
         $item:
           | PgSelectSingleStep<PgResource<any, TCodec, any, any, any>>
           | PgClassExpressionStep<TCodec, PgResource<any, any, any, any, any>>,

grafast/dataplan-pg/src/executor.ts

@@ -456,7 +456,7 @@ ${duration}
                 const pendingResult = defer<any[]>(); // CRITICAL: this MUST resolve later
                 results[resultIndex] = pendingResult;
                 scopedCache.set(identifiersJSON, pendingResult);
-                remaining.push(identifiersJSON) - 1;
+                remaining.push(identifiersJSON);
                 remainingDeferreds.push(pendingResult);
               }
             }

grafast/dataplan-pg/src/inspect.ts

@@ -12,6 +12,7 @@ export let inspect: {
 };
 
 try {
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   inspect = require("util").inspect;
   if (typeof inspect !== "function") {
     throw new Error("Failed to load inspect");