Replace TSLint with ESLint (#1230)

>[!Note]
>
>This PR is against the `version-8` branch.

## Description

TSLint has been EOL for several years. This replaces it with
typeScript-eslint and provides a comparable configuration for minimal
changes to the code.

## Documentation

Does this require changes to the WorkOS Docs? E.g. the [API
Reference](https://workos.com/docs/reference) or code snippets need
updates.

```
[ ] Yes
```

If yes, link a related docs PR and add a docs maintainer as a reviewer.
Their approval is required.

Author: nicknisi

eslint.config.mjs

@@ -0,0 +1,48 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import jestPlugin from 'eslint-plugin-jest';
+import n from 'eslint-plugin-n';
+
+const ignores = [
+  '**/*.snap',
+  'coverage',
+  'node_modules',
+  'dist',
+  'build',
+  'lib',
+];
+
+const tests = ['**/*.spec.{js,ts}'];
+
+export default tseslint.config(
+  {
+    ignores,
+  },
+  { linterOptions: { reportUnusedDisableDirectives: 'error' } },
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  n.configs['flat/recommended'],
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      '@typescript-eslint/no-require-imports': 'off',
+      'n/no-missing-import': 'off',
+      'n/no-unsupported-features/node-builtins': 'off',
+    },
+  },
+  {
+    files: tests,
+    extends: [jestPlugin.configs['flat/recommended']],
+    rules: {
+      'no-undef': 'off',
+      'jest/no-alias-methods': 'off',
+      'jest/no-identical-title': 'off',
+      'jest/no-disabled-tests': 'off',
+      'jest/no-conditional-expect': 'off',
+      'jest/valid-expect': 'off',
+    },
+  },
+);

package.json

@@ -29,7 +29,7 @@
   "scripts": {
     "clean": "rm -rf lib",
     "build": "tsc -p .",
-    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "lint": "eslint",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:worker": "jest src/worker.spec.ts",
@@ -45,19 +45,24 @@
     "qs": "6.14.0"
   },
   "devDependencies": {
+    "@eslint/js": "^9.21.0",
     "@peculiar/webcrypto": "^1.4.5",
     "@types/jest": "29.5.3",
     "@types/node": "14.18.54",
     "@types/pluralize": "0.0.30",
+    "@typescript-eslint/parser": "^8.25.0",
+    "eslint": "^9.21.0",
+    "eslint-plugin-jest": "^28.11.0",
+    "eslint-plugin-n": "^17.15.1",
     "jest": "29.6.2",
     "jest-environment-miniflare": "^2.14.2",
     "jest-fetch-mock": "^3.0.3",
     "nock": "^13.5.5",
     "prettier": "2.8.8",
     "supertest": "6.3.3",
     "ts-jest": "29.1.3",
-    "tslint": "6.1.3",
-    "typescript": "5.1.6"
+    "typescript": "5.1.6",
+    "typescript-eslint": "^8.25.0"
   },
   "exports": {
     "types": "./lib/index.d.ts",

src/common/net/node-client.ts

@@ -328,6 +328,7 @@ export class NodeHttpClientResponse
   _res: http_.IncomingMessage;
 
   constructor(res: http_.IncomingMessage) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     super(res.statusCode, res.headers || {});
     this._res = res;

src/common/utils/pagination.ts

@@ -1,7 +1,7 @@
 import { List, PaginationOptions } from '../interfaces';
 
 export class AutoPaginatable<T> {
-  readonly object: 'list' = 'list';
+  readonly object = 'list' as const;
   readonly options: PaginationOptions;
 
   constructor(

src/common/utils/test-utils.ts

@@ -1,7 +1,7 @@
 import fetch, { MockParams } from 'jest-fetch-mock';
 
 export function fetchOnce(
-  response: {} = {},
+  response = {},
   { status = 200, headers, ...rest }: MockParams = {},
 ) {
   return fetch.once(JSON.stringify(response), {

src/common/utils/unreachable.ts

@@ -9,7 +9,6 @@
  */
 export const unreachable = (
   condition: never,
-  // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
   message = `Entered unreachable code. Received '${condition}'.`,
 ): never => {
   throw new TypeError(message);

src/organizations/interfaces/create-organization-options.interface.ts

@@ -33,5 +33,7 @@ export interface SerializedCreateOrganizationOptions {
   domains?: string[];
 }
 
-export interface CreateOrganizationRequestOptions
-  extends Pick<PostOptions, 'idempotencyKey'> {}
+export type CreateOrganizationRequestOptions = Pick<
+  PostOptions,
+  'idempotencyKey'
+>;

src/user-management/interfaces/refresh-and-seal-session-data.interface.ts

@@ -6,6 +6,7 @@ export enum RefreshAndSealSessionDataFailureReason {
    * @deprecated To be removed in a future major version.
    */
   INVALID_SESSION_COOKE = 'invalid_session_cookie',
+  // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
   INVALID_SESSION_COOKIE = 'invalid_session_cookie',
   NO_SESSION_COOKIE_PROVIDED = 'no_session_cookie_provided',
 

src/workos.spec.ts

@@ -394,8 +394,7 @@ describe('WorkOS', () => {
     const fetchFn = globalThis.fetch;
 
     beforeEach(() => {
-      // @ts-ignore
-      delete globalThis.fetch;
+      delete (globalThis as any).fetch;
     });
 
     afterEach(() => {

tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "baseUrl": ".",
     "allowSyntheticDefaultImports": true,
     "alwaysStrict": true,
     "esModuleInterop": true,