[ONB-1618] Migrar ESLint a flat config sobre ESLint 10

.github/workflows/linters.yml

@@ -5,7 +5,7 @@ on:
     paths:
       - ".github/workflows/linters.yml"
       - "src/**"
-      - ".eslintrc.json"
+      - "eslint.config.mjs"
       - "tsconfig.json"
       - "tsconfig.module.json"
       - "package.json"

eslint.config.mjs

@@ -0,0 +1,83 @@
+import eslint from '@eslint/js';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import importX from 'eslint-plugin-import-x';
+import tsdoc from 'eslint-plugin-tsdoc';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default defineConfig(
+  globalIgnores(['build/**', 'coverage/**', '.nyc_output/**']),
+  {
+    linterOptions: {
+      reportUnusedDisableDirectives: 'error',
+    },
+  },
+  eslint.configs.recommended,
+  {
+    files: ['src/**/*.ts'],
+    extends: [
+      ...tseslint.configs.recommended,
+      importX.flatConfigs.recommended,
+      importX.flatConfigs.typescript,
+    ],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    plugins: {
+      tsdoc,
+    },
+    rules: {
+      '@typescript-eslint/await-thenable': 'error',
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'error',
+      '@typescript-eslint/no-misused-promises': 'error',
+      // Template-method hooks declare params their overrides may not use (tsconfig
+      // already has noUnusedParameters: false).
+      '@typescript-eslint/no-unused-vars': ['error', { args: 'none' }],
+      '@typescript-eslint/switch-exhaustiveness-check': 'error',
+      'import-x/extensions': ['error', 'never'],
+      'import-x/no-extraneous-dependencies': [
+        'error',
+        { devDependencies: ['src/spec/**'] },
+      ],
+      'import-x/order': [
+        'error',
+        {
+          alphabetize: { order: 'asc' },
+          'newlines-between': 'always',
+        },
+      ],
+      'no-console': ['error', { allow: ['warn', 'error'] }],
+      // Error.cause is unavailable on the SDK's supported Node 10 runtime.
+      'preserve-caught-error': 'off',
+      'no-restricted-syntax': [
+        'error',
+        'ForInStatement',
+        'LabeledStatement',
+        'WithStatement',
+      ],
+      'sort-imports': [
+        'error',
+        { ignoreCase: true, ignoreDeclarationSort: true },
+      ],
+      'tsdoc/syntax': 'error',
+    },
+  },
+  {
+    files: ['src/spec/**/*.ts'],
+    rules: {
+      'no-console': 'off',
+    },
+  },
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      globals: globals.node,
+      sourceType: 'commonjs',
+    },
+  },
+);

package.json

@@ -19,7 +19,8 @@
     "build": "run-p build:*",
     "build:main": "tsc -p tsconfig.json",
     "build:module": "tsc -p tsconfig.module.json",
-    "lint": "eslint src --ext .ts",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
     "test": "nyc --silent ava",
     "watch:build": "tsc -p tsconfig.json -w",
     "watch:test": "nyc --silent ava --watch --verbose",
@@ -40,21 +41,22 @@
     "@ava/typescript": "^6.0.0",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@types/sinon": "^10.0.3",
-    "@typescript-eslint/eslint-plugin": "^4.0.1",
-    "@typescript-eslint/parser": "^4.0.1",
+    "@typescript-eslint/parser": "^8.69.0",
+    "@eslint/js": "^10.0.1",
     "ava": "^6.4.0",
     "codecov": "^3.5.0",
-    "eslint": "^7.8.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-import": "^2.24.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
+    "eslint": "^10.9.1",
+    "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-tsdoc": "^0.5.2",
+    "globals": "^17.12.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "sinon": "^11.1.2",
     "ts-node": "^9.0.0",
     "typedoc": "^0.25.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.69.0"
   },
   "files": [
     "build/main",

src/lib/core.ts

@@ -1,4 +1,3 @@
-/* eslint-disable max-classes-per-file */
 import { Client } from './client';
 import { API_BASE_URL } from './constants';
 import {

src/lib/errors.ts

@@ -1,5 +1,3 @@
-/* eslint-disable max-classes-per-file */
-
 export class FintocError extends Error {
   constructor(errorData: Record<string, string>) {
     const errorType = errorData.type;

src/lib/managers/linksManager.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 import { ResourceArguments } from '../../types';
 import { ManagerMixin } from '../mixins';
 import { Link } from '../resources/link';

src/lib/mixins/managerMixin.ts

@@ -215,7 +215,6 @@ export abstract class ManagerMixin<ResourceType extends IResourceMixin> {
     return this.postDeleteHandler(identifier, innerArgs);
   }
 
-  /* eslint-disable class-methods-use-this, @typescript-eslint/no-unused-vars */
   protected postListHandler(
     objects: ResourceType[] | AsyncGenerator<ResourceType>,
     args: ResourceArguments,
@@ -246,5 +245,4 @@ export abstract class ManagerMixin<ResourceType extends IResourceMixin> {
     }
     return path;
   }
-  /* eslint-enable class-methods-use-this, @typescript-eslint/no-unused-vars */
 }

src/lib/mixins/resourceMixin.ts

@@ -53,7 +53,6 @@ export abstract class ResourceMixin<ResourceType> {
   ) {
     const content: Record<string, any> = {};
     for (const [key, value] of Object.entries(data)) {
-      /* eslint-disable no-await-in-loop */
       const rawResource = (this.mappings as Record<string, any>)[key] || key;
       if (value !== undefined) {
         if (Array.isArray(value)) {
@@ -66,7 +65,6 @@ export abstract class ResourceMixin<ResourceType> {
           content[key] = await objetize(klass, client, value);
         }
       }
-      /* eslint-enable no-await-in-loop */
     }
     // @ts-ignore: cannot create an instance of an abstract class
     return new this(client, handlers, methods, path, content);

src/lib/paginator.ts

@@ -57,7 +57,6 @@ export async function* paginate(options: IPaginationOptions) {
   let response = await request({
     client, path, headers, params,
   });
-  /* eslint-disable no-await-in-loop */
   for (const element of response.elements) {
     yield element;
   }
@@ -67,5 +66,4 @@ export async function* paginate(options: IPaginationOptions) {
       yield element;
     }
   }
-  /* eslint-enable no-await-in-loop */
 }

src/lib/resources/account.ts

@@ -31,7 +31,7 @@ export class Account extends ResourceMixin<Account> {
     return this.#movementsManager;
   }
 
-  set movements(newValue) { /* eslint-disable-line class-methods-use-this */
+  set movements(newValue) {
     throw new ReferenceError('Attribute name corresponds to a manager');
   }
 }

src/lib/resources/link.ts

@@ -54,7 +54,7 @@ export class Link extends ResourceMixin<Link> {
     return this.#accountsManager;
   }
 
-  set accounts(newValue) { /* eslint-disable-line class-methods-use-this */
+  set accounts(newValue) {
     throw new ReferenceError('Attribute name corresponds to a manager');
   }
 
@@ -72,7 +72,7 @@ export class Link extends ResourceMixin<Link> {
     return this.#subscriptionsManager;
   }
 
-  set subscriptions(newValue) { /* eslint-disable-line class-methods-use-this */
+  set subscriptions(newValue) {
     throw new ReferenceError('Attribute name corresponds to a manager');
   }
 
@@ -90,7 +90,7 @@ export class Link extends ResourceMixin<Link> {
     return this.#taxReturnsManager;
   }
 
-  set taxReturns(newValue) { /* eslint-disable-line class-methods-use-this */
+  set taxReturns(newValue) {
     throw new ReferenceError('Attribute name corresponds to a manager');
   }
 
@@ -108,7 +108,7 @@ export class Link extends ResourceMixin<Link> {
     return this.#invoicesManager;
   }
 
-  set invoices(newValue) { /* eslint-disable-line class-methods-use-this */
+  set invoices(newValue) {
     throw new ReferenceError('Attribute name corresponds to a manager');
   }
 
@@ -126,7 +126,7 @@ export class Link extends ResourceMixin<Link> {
     return this.#refreshIntentsManager;
   }
 
-  set refreshIntents(newValue) { /* eslint-disable-line class-methods-use-this */
+  set refreshIntents(newValue) {
     throw new ReferenceError('Attribute name corresponds to a manager');
   }
 }

src/lib/utils.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosError } from 'axios';
+import axios from 'axios';
 
 import { IModule } from '../interfaces/module';
 import { GenericFunction } from '../types';
@@ -127,7 +127,7 @@ export function canRaiseHTTPError(
   newDescriptor.value = async function wrapper(...args: any[]) {
     try {
       return await descriptor.value.apply(this, args);
-    } catch (exc: any | AxiosError<string>) {
+    } catch (exc: any) {
       if (axios.isAxiosError(exc) && exc.response) {
         const errorData = exc.response.data as Record<string, any>;
         const ErrorKlass = getErrorClass(errorData.error.type);

src/lib/webhook.ts

@@ -12,7 +12,7 @@ export class WebhookSignature {
    * @param header - The Fintoc-Signature header value
    * @param secret - Your webhook secret key (found in your Fintoc dashboard)
    * @param tolerance - Number of seconds to tolerate when checking timestamp (default: 300)
-   * @throws {WebhookSignatureError} If the signature is invalid or timestamp is outside
+   * @throws {@link WebhookSignatureError} If the signature is invalid or timestamp is outside
    * tolerance window
    */
   public static verifyHeader(

src/spec/jws.spec.ts

@@ -79,21 +79,18 @@ test('JWSSignature initialization with file path', (t) => {
 
 test('JWSSignature throws error with invalid input type', (t) => {
   t.throws(() => {
-    // eslint-disable-next-line no-new
     new JWSSignature(123 as any);
   }, { message: /Private key must be a string/ });
 });
 
 test('JWSSignature throws error with non-existent file path', (t) => {
   t.throws(() => {
-    // eslint-disable-next-line no-new
     new JWSSignature('/non/existent/path.pem');
   }, { message: /Failed to read private key file/ });
 });
 
 test('JWSSignature throws error with invalid key format', (t) => {
   t.throws(() => {
-    // eslint-disable-next-line no-new
     new JWSSignature('invalid-key-content');
   }, { message: /Invalid private key format/ });
 });

src/spec/mixins/managerMixin/handlers.spec.ts

@@ -1,5 +1,3 @@
-/* eslint-disable no-console */
-
 import test from 'ava';
 
 import { Client } from '../../../lib/client';

src/spec/mixins/managerMixin/mocks/complexMockManager.ts

@@ -1,5 +1,3 @@
-/* eslint-disable no-console, class-methods-use-this, @typescript-eslint/no-unused-vars */
-
 import { ManagerMixin } from '../../../../lib/mixins';
 import { ResourceArguments } from '../../../../types';
 

src/spec/mixins/resourceMixin/serialization.spec.ts

@@ -1,5 +1,3 @@
-/* eslint-disable no-console */
-
 import test from 'ava';
 
 import { Client } from '../../../lib/client';

src/spec/utils/canRaiseHTTPError.spec.ts

@@ -1,13 +1,11 @@
-/* eslint-disable class-methods-use-this */
-
 import test from 'ava';
 
 import { FintocError } from '../../lib/errors';
 import { canRaiseHTTPError } from '../../lib/utils';
 
 class Errors {
   @canRaiseHTTPError
-  noError() { } /* eslint-disable-line @typescript-eslint/no-empty-function */
+  noError() { }
 
   @canRaiseHTTPError
   throwHTTPError() {