Replace tslint with typescript-eslint (#1030)

* Add basic eslint 9 flat config

* Add @eslint/js and typescript-eslint

* Fix some errors, mostly type imports and git add .

* Fix some lint errors

* Fix lint issues

* This works

* Run prettier

* Remove unused @ts-expect-error

* Add comment to eslint.config.mjs

* Add stylistic rules and turn off majority

* Enable no-inferrable-types & prefer-for-of rules

* Format code

* Enable consistent-type-assertions rule

* Enable no-confusing-non-null-assertion rule

* Fix few lint issues & turn off erroring rules

eslint.config.mjs

@@ -0,0 +1,38 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  ...tseslint.configs.stylistic,
+  {
+    files: ["packages/*/src/**/*.ts"],
+    languageOptions: {
+      parser: tseslint.parser,
+      // parserOptions: {
+      //   project: true,
+      // },
+    },
+    rules: {
+      "@typescript-eslint/no-unnecessary-type-constraint": "warn",
+      // Svelte doesn't correctly compile if imports of the generated /modules
+      // aren't imported as 'import type' in other parts of the generated
+      // querybuilder, so set this option to ensure we always do that
+      "@typescript-eslint/consistent-type-imports": "error",
+      "@typescript-eslint/no-namespace": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-empty-function": "warn",
+      "@typescript-eslint/ban-ts-comment": "warn",
+      "no-empty-function": "off",
+      "@typescript-eslint/class-literal-property-style": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+      ],
+      // some stylistic rules results with errors, turn them off for now
+      "@typescript-eslint/consistent-indexed-object-style": "off",
+      "@typescript-eslint/consistent-type-definitions": "off",
+      "@typescript-eslint/no-empty-interface": "off",
+    },
+  }
+);

package.json

@@ -7,19 +7,15 @@
   ],
   "packageManager": "[email protected]",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.60.1",
-    "@typescript-eslint/parser": "^5.60.1",
-    "eslint": "^8.43.0",
-    "eslint-config-prettier": "^8.8.0",
+    "@eslint/js": "^9.2.0",
+    "eslint": "^9.2.0",
     "prettier": "^2.8.8",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-plugin-prettier": "^2.3.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.8.0"
   },
   "scripts": {
-    "lint": "tslint 'packages/*/src/**/*.ts'",
-    "eslint": "eslint 'packages/*/src/**/*.ts'",
+    "lint": "eslint --quiet 'packages/*/src/**/*.ts'",
+    "lint:fix": "eslint 'packages/*/src/**/*.ts' --fix",
     "format:check": "prettier --check 'packages/*/src/**/*.(mts|ts)' 'packages/*/test/**/*.ts'",
     "format": "prettier --write 'packages/*/src/**/*.(mts|ts)' 'packages/*/test/**/*.ts'",
     "generate": "yarn workspace @edgedb/generate generate"

packages/auth-nextjs/src/pages/client.ts

@@ -77,7 +77,7 @@ export class NextPagesClientAuth extends NextAuthHelpers {
 }
 
 async function apiRequest(url: string, _data: any) {
-  let data: { [key: string]: any };
+  let data: Record<string, any>;
   if (_data instanceof FormData) {
     data = {};
     for (const [key, val] of _data.entries()) {

packages/auth-nextjs/src/pages/server.ts

@@ -27,11 +27,7 @@ export default function createNextPagesServerAuth(
 const sessionCache = new WeakMap<any, NextAuthSession>();
 
 export class NextPagesAuth extends NextAuth {
-  getSession(req: {
-    cookies: Partial<{
-      [key: string]: string;
-    }>;
-  }) {
+  getSession(req: { cookies: Partial<Record<string, string>> }) {
     const session =
       sessionCache.get(req) ??
       new NextAuthSession(

packages/auth-remix/src/server.ts

@@ -158,7 +158,7 @@ export class RemixServerAuth extends RemixClientAuth {
         params,
       }: {
         request: Request;
-        params: { [key: string]: string | undefined };
+        params: Record<string, string | undefined>;
       }) => {
         const path = params["*"];
         if (!path) {

packages/create/src/recipes/nextjs/template/ts/src/app/auth/[...auth]/route.__auth.ts

@@ -1,8 +1,17 @@
 import { redirect } from "next/navigation";
 import { auth } from "@/edgedb";
+import type { TokenData } from "@edgedb/auth-core";
 
 export const { GET, POST } = auth.createAuthRouteHandlers({
-  async onBuiltinUICallback({ error, tokenData, provider, isSignUp }) {
+  async onBuiltinUICallback({
+    error,
+    tokenData,
+    isSignUp,
+  }: {
+    error?: Error;
+    tokenData?: TokenData;
+    isSignUp?: boolean;
+  }) {
     if (error) {
       console.error("sign in failed", error);
     }

packages/create/src/recipes/nextjs/template/ts/src/pages.__pages/api/hello.__auth.ts

@@ -3,10 +3,10 @@ import type { NextApiRequest, NextApiResponse } from "next";
 
 import { auth } from "@/edgedb";
 
-type Data = {
+interface Data {
   name: string;
   identity: any;
-};
+}
 
 export default async function handler(
   req: NextApiRequest,

packages/create/src/recipes/nextjs/template/ts/src/pages.__pages/api/hello.ts

@@ -1,9 +1,9 @@
 // Next.js API route support: https://nextjs.org/docs/api-routes/introduction
 import type { NextApiRequest, NextApiResponse } from "next";
 
-type Data = {
+interface Data {
   name: string;
-};
+}
 
 export default function handler(
   req: NextApiRequest,

packages/create/src/utils.ts

@@ -43,8 +43,7 @@ export async function copyTemplateFiles(
           vars[filepath].push({ varname, value });
         }
         return vars;
-      }, {} as { [filepath: string]: { varname: string; value: string }[] }) ??
-      {},
+      }, {} as Record<string, { varname: string; value: string }[]>) ?? {},
   });
 }
 
@@ -53,11 +52,11 @@ async function _walkDir(
   _dest: string,
   untaggedSource: string,
   opts: Omit<CopyTemplateFilesOpts, "injectVars"> & {
-    injectVars: { [filepath: string]: { varname: string; value: string }[] };
+    injectVars: Record<string, { varname: string; value: string }[]>;
   }
 ) {
-  const files: { [filename: string]: { entry: Dirent; tags: string[] }[] } = {};
-  const dirs: { [dirname: string]: { entry: Dirent; tags: string[] }[] } = {};
+  const files: Record<string, { entry: Dirent; tags: string[] }[]> = {};
+  const dirs: Record<string, { entry: Dirent; tags: string[] }[]> = {};
   for (const entry of await fs.readdir(source, { withFileTypes: true })) {
     const parts = entry.name.split(".");
     const name = [

packages/driver/src/adapter.crypto.node.ts

@@ -3,7 +3,7 @@ import type { CryptoUtils } from "./utils";
 let cryptoUtils: CryptoUtils;
 
 if (typeof crypto === "undefined") {
-  // tslint:disable-next-line:no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
   const nodeCrypto = require("crypto");
 
   cryptoUtils = {
@@ -32,7 +32,7 @@ if (typeof crypto === "undefined") {
     },
   };
 } else {
-  // tslint:disable-next-line:no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
   cryptoUtils = require("./browserCrypto").default;
 }
 

packages/driver/src/adapter.deno.ts

@@ -135,7 +135,7 @@ export function homeDir(): string {
 export async function input(message = "", _params?: { silent?: boolean }) {
   const buf = new Uint8Array(1024);
   await Deno.stdout.write(new TextEncoder().encode(message));
-  const n = <number>await Deno.stdin.read(buf);
+  const n = (await Deno.stdin.read(buf)) as number;
   return new TextDecoder().decode(buf.subarray(0, n)).trim();
 }
 
@@ -162,6 +162,7 @@ export namespace net {
 
   export const isIP = _isIP;
 
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
   export declare interface Socket {
     on(eventName: "error", listener: (e: any) => void): this;
     on(eventName: "connect", listener: () => void): this;
@@ -234,6 +235,7 @@ export namespace net {
     }
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
   export class Socket extends BaseSocket<Deno.Conn> {
     constructor(pconn: Promise<Deno.Conn>) {
       super();
@@ -272,8 +274,8 @@ export namespace tls {
   }
 
   export function checkServerIdentity(
-    hostname: string,
-    cert: Object
+    _hostname: string,
+    _cert: object
   ): Error | undefined {
     return undefined;
   }

packages/driver/src/adapter.node.ts

@@ -85,7 +85,7 @@ export function input(
 ): Promise<string> {
   let silent = false;
 
-  const output = !!params?.silent
+  const output = params?.silent
     ? new Writable({
         write(
           chunk: any,
@@ -102,7 +102,7 @@ export function input(
     output,
   });
 
-  return new Promise((resolve, rej) => {
+  return new Promise((resolve) => {
     rl.question(message, (val) => {
       rl.close();
       resolve(val);

packages/driver/src/adapter.shared.node.ts

@@ -1,6 +1,3 @@
-export function getEnv(
-  envName: string,
-  required: boolean = false
-): string | undefined {
+export function getEnv(envName: string, _required = false): string | undefined {
   return process.env[envName];
 }

packages/driver/src/baseClient.ts

@@ -18,26 +18,32 @@
 
 import type { Duration } from "./datatypes/datetime";
 import { CodecsRegistry } from "./codecs/registry";
-import {
+import type {
   ConnectArgumentsParser,
   ConnectConfig,
   NormalizedConnectConfig,
   ResolvedConnectConfigReadonly,
 } from "./conUtils";
 import * as errors from "./errors";
-import { Cardinality, Executor, OutputFormat, QueryArgs } from "./ifaces";
 import {
-  Options,
+  type Executor,
+  type QueryArgs,
+  Cardinality,
+  OutputFormat,
+} from "./ifaces";
+import type {
   RetryOptions,
   Session,
   SimpleRetryOptions,
   SimpleTransactionOptions,
   TransactionOptions,
 } from "./options";
+import { Options } from "./options";
 import Event from "./primitives/event";
 import { LifoQueue } from "./primitives/queues";
-import { BaseRawConnection } from "./baseConn";
-import { ConnectWithTimeout, retryingConnect } from "./retry";
+import type { BaseRawConnection } from "./baseConn";
+import type { ConnectWithTimeout } from "./retry";
+import { retryingConnect } from "./retry";
 import { util } from "./reflection/util";
 import { Transaction } from "./transaction";
 import { sleep } from "./utils";
@@ -121,7 +127,7 @@ export class ClientConnectionHolder {
     action: (transaction: Transaction) => Promise<T>
   ): Promise<T> {
     let result: T | void;
-    for (let iteration = 0; true; ++iteration) {
+    for (let iteration = 0; ; ++iteration) {
       const transaction = await Transaction._startTransaction(this);
 
       let commitFailed = false;
@@ -173,7 +179,7 @@ export class ClientConnectionHolder {
     expectedCardinality: Cardinality
   ): Promise<any> {
     let result: any;
-    for (let iteration = 0; true; ++iteration) {
+    for (let iteration = 0; ; ++iteration) {
       const conn = await this._getConnection();
       try {
         result = await conn.fetch(
@@ -438,7 +444,6 @@ export abstract class BaseClientPool {
     );
 
     const warningTimeoutId = setTimeout(() => {
-      // tslint:disable-next-line: no-console
       console.warn(
         "Client.close() is taking over 60 seconds to complete. " +
           "Check if you have any unreleased connections left."
@@ -534,7 +539,7 @@ export class Client implements Executor {
     return new Client(this.pool, this.options.withSession(session));
   }
 
-  withModuleAliases(aliases: { [name: string]: string }) {
+  withModuleAliases(aliases: Record<string, string>) {
     return new Client(
       this.pool,
       this.options.withSession(this.options.session.withModuleAliases(aliases))
@@ -546,7 +551,7 @@ export class Client implements Executor {
     return new Client(this.pool, this.options.withSession(newConfig));
   }
 
-  withGlobals(globals: { [name: string]: any }): Client {
+  withGlobals(globals: Record<string, any>): Client {
     return new Client(
       this.pool,
       this.options.withSession(this.options.session.withGlobals(globals))