Migrate monorepo from TSLint to ESLint

.eslintrc.js

@@ -0,0 +1,72 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  plugins: [
+    '@typescript-eslint'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  rules: {
+    '@typescript-eslint/array-type': 'error',
+    '@typescript-eslint/explicit-member-accessibility': [
+      'error', { 'accessibility': 'no-public' }
+    ],
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-empty-interface': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/quotes': ['error', 'single'],
+    'arrow-parens': ['error', 'as-needed'],
+    'max-classes-per-file': 'off',
+    'no-console': 'off',
+    'no-duplicate-imports': 'error',
+    'no-empty': 'off',
+    'no-shadow': 'off',
+    'comma-dangle': 'off',
+    'sort-keys': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { 'args':  'none' }],
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/require-await': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    // Monorepo additions: disable rules that fire on intentional framework patterns
+    'no-prototype-builtins': 'off',                                    // .hasOwnProperty() in session.ts, service-manager.ts, swagger-controller.ts
+    '@typescript-eslint/no-misused-promises': 'off',                   // new Promise(async ...) in storage, setImmediate(async ...) in async.service.ts
+    '@typescript-eslint/restrict-template-expressions': 'off',         // template literals with non-string types throughout packages/
+    '@typescript-eslint/no-floating-promises': 'off',                  // fire-and-forget patterns in socketio-controller.service.ts
+    '@typescript-eslint/ban-types': 'off',                             // Function type in context.ts
+    '@typescript-eslint/quotes': 'off',                                // overrides template's 'single' — framework code uses double quotes in many places; fix in follow-up PR
+    'no-case-declarations': 'off',                                     // let/const in switch cases in cli.ts, jwt, sessions
+    'no-useless-escape': 'off',                                        // regex escape patterns in generator.ts, swagger-controller.ts
+    '@typescript-eslint/await-thenable': 'off',                        // await on sync functions in spec files — pre-existing test style
+    '@typescript-eslint/no-unnecessary-type-assertion': 'off',         // type narrowing assertions in spec files
+    '@typescript-eslint/no-base-to-string': 'off',                     // service objects in template literals in spec files
+    '@typescript-eslint/no-redundant-type-constituents': 'off',        // any in union types in config.ts, interfaces.ts
+    '@typescript-eslint/no-this-alias': 'off',                         // const self = this pattern in spec files
+    'no-inner-declarations': 'off',                                    // function declarations inside blocks in jwt.hook.spec.ts
+    'no-async-promise-executor': 'off',                                // new Promise(async ...) in redis-store and parse-and-validate-files
+    'no-extra-semi': 'off',                                            // extra semicolon in logger.ts
+    '@typescript-eslint/ban-ts-comment': 'off',                        // @ts-ignore in service-manager.ts — separate PR per plan
+  },
+  ignorePatterns: [
+    'src/migrations/*.ts',
+    '**/src/migrations/*.ts',
+    '**/src/generate/fixtures/**/*.ts',
+    'packages/cli/fixtures',
+    'packages/cli/specs',
+    'packages/cli/templates',
+    '**/*.d.ts',
+  ]
+};

package.json

@@ -10,8 +10,8 @@
     "examples/*"
   ],
   "scripts": {
-    "lint": "tslint -c tslint.json --project tsconfig.json",
-    "lint:fix": "tslint -c tslint.json --project tsconfig.json --fix"
+    "lint": "eslint packages --ext .ts",
+    "lint:fix": "eslint packages --ext .ts --fix"
   },
   "repository": {
     "type": "git",
@@ -23,10 +23,12 @@
   },
   "homepage": "https://github.com/FoalTS/foal#readme",
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "~6.5.0",
+    "@typescript-eslint/parser": "~6.5.0",
     "@types/mocha": "10.0.10",
+    "eslint": "~8.48.0",
     "lerna": "~9.0.0",
     "mocha": "~11.7.5",
-    "tslint": "~6.1.3",
     "typescript": "~5.5.4"
   }
 }

packages/cli/src/cli.ts

@@ -19,7 +19,6 @@ function displayError(...lines: string[]): void {
   process.exitCode = 1;
 }
 
-// tslint:disable-next-line:no-var-requires
 const pkg = require('../package.json');
 
 program

packages/core/src/common/validation/get-ajv-instance.ts

@@ -4,7 +4,6 @@ import { Config } from '../../core';
 import addFormats from 'ajv-formats';
 
 // This is a little hack to test the customized configuration of `getAjvInstance`.
-// tslint:disable-next-line:variable-name
 export const _instanceWrapper: { instance: undefined|Ajv } = {
   instance: undefined
 };

packages/core/src/common/validation/validate-cookie.hook.ts

@@ -33,7 +33,6 @@ export function ValidateCookie(
   schema: object | ((controller: any) => object) = { type: 'string' } ,
   options: { openapi?: boolean, required?: boolean } = {}
 ): HookDecorator {
-  // tslint:disable-next-line
   const required = options.required ?? true;
 
   let validateSchema: ValidateFunction|undefined;

packages/core/src/common/validation/validate-header.hook.ts

@@ -31,7 +31,6 @@ export function ValidateHeader(
   schema: object | ((controller: any) => object) = { type: 'string' },
   options: { openapi?: boolean, required?: boolean } = {}
 ): HookDecorator {
-  // tslint:disable-next-line
   const required = options.required ?? true;
   name = name.toLowerCase();
 

packages/core/src/common/validation/validate-query-param.hook.ts

@@ -33,7 +33,6 @@ export function ValidateQueryParam(
   schema: object | ((controller: any) => object) = { type: 'string' },
   options: { openapi?: boolean, required?: boolean } = {}
 ): HookDecorator {
-  // tslint:disable-next-line
   const required = options.required ?? true;
 
   let validateSchema: ValidateFunction|undefined;

packages/core/src/core/hooks.ts

@@ -46,7 +46,6 @@ export function Hook<C = Context>(
     hooks.unshift(hookFunction);
     Reflect.defineMetadata('hooks', hooks, target, propertyKey as string);
 
-    // tslint:disable-next-line
     if (!(options.openapi ?? Config.get('settings.openapi.useHooks', 'boolean', true))) {
       return;
     }

packages/core/src/core/http/context.ts

@@ -22,7 +22,6 @@ interface IncomingMessage extends Readable {
   trailers: any;
   url?: string;
   destroy(err?: any): void;
-  // tslint:disable-next-line:ban-types
   setTimeout(msecs: number, callback: Function): this;
 }
 

packages/core/src/core/routes/make-controller-routes.spec.ts

@@ -299,7 +299,6 @@ describe('makeControllerRoutes', () => {
 
   it('should bind the controller instance to the controller and method hooks.', () => {
     let firstThis: FoobarController|undefined;
-    // tslint:disable-next-line:prefer-const
     let secondThis: FoobarController|undefined;
 
     @Hook(function(this: FoobarController) {

packages/core/src/sessions/core/create-session.spec.ts

@@ -52,17 +52,14 @@ describe('createSession', () => {
     it('with an empty userId.', async () => {
       await session.commit();
 
-      // tslint:disable-next-line
       const state = store.updateCalledWith?.state ?? store.saveCalledWith?.state;
 
-      // tslint:disable-next-line
       strictEqual(state?.userId, null);
     });
 
     it('with a csrfToken generated randomly (256-bit base64url-encoded string).', async () => {
       await session.commit();
 
-      // tslint:disable-next-line
       const state = store.updateCalledWith?.state ?? store.saveCalledWith?.state;
       if (!state) {
         throw new Error('Unexpected error.');
@@ -80,7 +77,6 @@ describe('createSession', () => {
       await session.commit();
       const dateAfter = Math.trunc(Date.now() / 1000) + 1;
 
-      // tslint:disable-next-line
       const state = store.updateCalledWith?.state ?? store.saveCalledWith?.state;
 
       if (!state) {
@@ -104,9 +100,7 @@ describe('createSession', () => {
     it('that should be marked as "non-existing".', async () => {
       await session.commit();
 
-      // tslint:disable-next-line
       strictEqual(store.updateCalledWith?.state, undefined);
-      // tslint:disable-next-line
       notStrictEqual(store.saveCalledWith?.state, undefined);
     });
 

packages/core/src/sessions/core/read-session.spec.ts

@@ -43,7 +43,6 @@ describe('readSession', () => {
       this.saveCalledWith = { state, maxInactivity };
     }
     async read(id: string): Promise<SessionState | null> {
-      // tslint:disable-next-line
       return this.sessionStates.get(id) ?? null;
     }
     async update(state: SessionState, maxInactivity: number): Promise<void> {
@@ -93,7 +92,6 @@ describe('readSession', () => {
 
           await session.commit();
 
-          // tslint:disable-next-line
           const state = store.updateCalledWith?.state ?? store.saveCalledWith?.state;
           if (!state) {
             throw new Error('state should be defined.');
@@ -116,9 +114,7 @@ describe('readSession', () => {
 
           await session.commit();
 
-          // tslint:disable-next-line
           notStrictEqual(store.updateCalledWith?.state, undefined);
-          // tslint:disable-next-line
           strictEqual(store.saveCalledWith?.state, undefined);
         });
 

packages/core/src/sessions/core/session.spec.ts

@@ -442,13 +442,9 @@ describe('Session', () => {
         await session.commit();
 
         state = typeof state === 'function' ? state() : state;
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.id, state.id);
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.userId, state.userId);
-        // tslint:disable-next-line
         deepStrictEqual(store[calledWithPropertyName]?.state.content, state.content);
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.createdAt, state.createdAt);
       });
 
@@ -458,7 +454,6 @@ describe('Session', () => {
         session.setUser(user);
         await session.commit();
 
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.userId, user.id);
       });
 
@@ -468,7 +463,6 @@ describe('Session', () => {
         session.setUser(user);
         await session.commit();
 
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.userId, user.id);
       });
 
@@ -477,7 +471,6 @@ describe('Session', () => {
         session.setUser(user);
         await session.commit();
 
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.userId, 1);
       });
 
@@ -486,19 +479,16 @@ describe('Session', () => {
         session.setUser(user as any);
         await session.commit();
 
-        // tslint:disable-next-line
         strictEqual(store[calledWithPropertyName]?.state.userId, user._id);
       });
 
       it('with the proper content modified with the "set" method.', async () => {
         session.set('foo', 'bar');
         await session.commit();
 
-        // tslint:disable-next-line
         deepStrictEqual(store[calledWithPropertyName]?.state.content, {
           foo: 'bar'
         });
-        // tslint:disable-next-line
         deepStrictEqual(store[calledWithPropertyName]?.state.flash, {});
       });
 
@@ -507,9 +497,7 @@ describe('Session', () => {
         await session.commit();
 
         state = typeof state === 'function' ? state() : state;
-        // tslint:disable-next-line
         deepStrictEqual(store[calledWithPropertyName]?.state.content, state.content);
-        // tslint:disable-next-line
         deepStrictEqual(store[calledWithPropertyName]?.state.flash, {
           hello: 'world'
         });
@@ -542,15 +530,13 @@ describe('Session', () => {
 
         it('from the framework default values.', async () => {
           await session.commit();
-          // tslint:disable-next-line
           strictEqual(store[calledWithPropertyName]?.maxInactivity, SESSION_DEFAULT_INACTIVITY_TIMEOUT);
         });
 
         it('from the configuration.', async () => {
           Config.set('settings.session.expirationTimeouts.inactivity', 1);
 
           await session.commit();
-          // tslint:disable-next-line
           strictEqual(store[calledWithPropertyName]?.maxInactivity, 1);
         });
 

packages/core/src/sessions/core/session.ts

@@ -86,7 +86,6 @@ export class Session {
    * @memberof Session
    */
   setUser(user: { id: number|string|object } | { _id: number|string|object }): void {
-    // tslint:disable-next-line
     const id: number|string|object = (user as any).id ?? (user as any)._id;
     if (typeof id === 'object') {
       this.state.userId = id.toString();

packages/core/src/sessions/http/use-sessions.hook.spec.ts

@@ -695,7 +695,6 @@ describe('UseSessions', () => {
             await hook(ctx, services);
 
             strictEqual(ctx.user, null);
-            // tslint:disable-next-line
             strictEqual(ctx.session?.isDestroyed, true);
           });
 
@@ -865,7 +864,6 @@ describe('UseSessions', () => {
 
           await postHookFunction(new HttpResponseInternalServerError());
 
-          // tslint:disable-next-line
           strictEqual(services.get(Store).updateCalledWith?.state.id, undefined);
         });
 
@@ -1079,7 +1077,6 @@ describe('UseSessions', () => {
 
           await postHookFunction(new HttpResponseOK());
 
-          // tslint:disable-next-line
           strictEqual(services.get(Store).updateCalledWith?.state.id, ctx.session.getToken());
         });
 

packages/jwks-rsa/src/get-rsa-public-key-from-jwks.ts

@@ -4,7 +4,6 @@ import { Agent as HttpsAgent } from 'https';
 
 // 3p
 import { InvalidTokenError } from '@foal/jwt';
-// tslint:disable-next-line:no-var-requires
 const jwksClient = require('jwks-rsa');
 
 // The below interfaces comes from here: https://github.com/auth0/node-jwks-rsa/blob/master/index.d.ts

packages/jwt/src/http/jwt.hook.spec.ts

@@ -73,14 +73,13 @@ function toBase64Url(headerOrPayload: string): string {
   return convertBase64ToBase64url(Buffer.from(headerOrPayload, 'binary').toString('base64'));
 }
 
-/* tslint:disable-next-line:no-unused-variable */
+/* eslint-disable-next-line @typescript-eslint/no-unused-vars */
 function fromBase64Url(str: string): string {
   return Buffer.from(convertBase64urlToBase64(str), 'base64').toString('binary');
 }
 
 const payload1 = {
   sub: '1234567890',
-  // tslint:disable-next-line:object-literal-sort-keys
   name: 'John Doe',
   iat: 1516239022
 };

packages/socket.io/src/architecture/event-name.decorator.spec.ts

@@ -22,7 +22,7 @@ describe('EventName', () => {
   it('should throw an error if the event name is empty.', () => {
     throws(
       () => {
-        // tslint:disable-next-line:no-unused-variable
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         class Foobar {
           @EventName('')
           barfoo() {}

packages/socket.io/src/routes/make-websocket-controller-routes.spec.ts

@@ -260,7 +260,6 @@ describe('makeWebsocketControllerRoutes', () => {
 
   it('should bind the controller instance to the controller and method hooks.', () => {
     let firstThis: FoobarController|undefined;
-    // tslint:disable-next-line:prefer-const
     let secondThis: FoobarController|undefined;
 
     @WebsocketHook(function(this: FoobarController) {

packages/socket.io/src/socketio-controller.service.spec.ts

@@ -2,7 +2,7 @@
 import { deepStrictEqual, notDeepStrictEqual, notStrictEqual, strictEqual } from 'assert';
 import { createServer, Server } from 'http';
 import { AddressInfo } from 'net';
-// tslint:disable-next-line: no-duplicate-imports
+// eslint-disable-next-line no-duplicate-imports
 import * as http from 'http';
 import { mock } from 'node:test';
 

packages/typeorm/src/typeorm-store.service.spec.ts

@@ -276,9 +276,7 @@ function storeTestSuite(type: DBType) {
         flash: JSON.stringify(state.flash),
         id: state.id,
         updated_at: state.updatedAt,
-        // tslint:disable-next-line
         user_id: userIdNumber ?? undefined,
-        // tslint:disable-next-line
         user_id_str: userIdStr ?? undefined,
       });
     }