Update ESLint and related pacakges, adapt config

Author: flevi29

.eslintignore

@@ -0,0 +1,82 @@
+const eslint = require('@eslint/js');
+const tseslint = require('typescript-eslint');
+const tsdoc = require('eslint-plugin-tsdoc');
+const jest = require('eslint-plugin-jest');
+const globals = require('globals');
+const prettier = require('eslint-config-prettier');
+
+/** @type {import('eslint').Linter.Config[]} */
+module.exports = [
+  {
+    ignores: ['dist/', 'tests/env/', 'coverage/', 'playgrounds/', 'docs/'],
+  },
+  // Standard linting for js files
+  {
+    files: ['**/*.js'],
+    languageOptions: { sourceType: 'script', globals: globals.node },
+    plugins: { eslint },
+    rules: eslint.configs.recommended.rules,
+  },
+  // TypeScript linting for ts files
+  ...tseslint.configs.recommendedTypeChecked.map((config) => ({
+    ...config,
+    files: ['**/*.ts'],
+    languageOptions: {
+      globals: globals.node,
+      parser: tseslint.parser,
+      parserOptions: { project: 'tsconfig.eslint.json' },
+    },
+    plugins: { ...config.plugins, tsdoc },
+    rules: {
+      ...config.rules,
+      'tsdoc/syntax': 'error',
+      // @TODO: Remove the ones between "~~", adapt code
+      // ~~
+      '@typescript-eslint/prefer-as-const': 'off',
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-floating-promises': 'off',
+      // ~~
+      '@typescript-eslint/array-type': ['warn', { default: 'array-simple' }],
+      // @TODO: Should be careful with this rule, should leave it be and disable
+      //       it within files where necessary with explanations
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        // argsIgnorePattern: https://eslint.org/docs/latest/rules/no-unused-vars#argsignorepattern
+        // varsIgnorePattern: https://eslint.org/docs/latest/rules/no-unused-vars#varsignorepattern
+        { args: 'all', argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      // @TODO: Not recommended to disable rule, should instead disable locally
+      //       with explanation
+      '@typescript-eslint/ban-ts-ignore': 'off',
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  })),
+  // Jest linting for test files
+  {
+    files: ['tests/*.ts'],
+    ...jest.configs['flat/recommended'],
+    // languageOptions: {
+    //   ...jest.configs['flat/recommended'].languageOptions,
+    //   globals: globals.jest,
+    // },
+    rules: {
+      ...jest.configs['flat/recommended'].rules,
+      // @TODO: Remove all of these rules and adapt code!
+      'jest/no-disabled-tests': 'off',
+      'jest/expect-expect': 'off',
+      'jest/no-conditional-expect': 'off',
+      'jest/valid-title': 'off',
+      'jest/no-jasmine-globals': 'off',
+      'jest/valid-expect-in-promise': 'off',
+      'jest/valid-expect': 'off',
+      'jest/no-alias-methods': 'off',
+    },
+  },
+  prettier,
+];

eslint.config.js

@@ -53,8 +53,8 @@
     "style:fix": "yarn fmt:fix && yarn lint:fix",
     "fmt": "prettier -c ./**/*.{js,ts}",
     "fmt:fix": "prettier -w ./**/*.{js,ts}",
-    "lint": "eslint --ext .js,.ts,.tsx .",
-    "lint:fix": "eslint --ext .js,.ts,.tsx --fix .",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
     "typingsheader": "node scripts/build.js"
   },
   "files": [
@@ -75,18 +75,19 @@
   "devDependencies": {
     "@babel/core": "^7.25.2",
     "@babel/preset-env": "^7.25.4",
+    "@eslint/js": "^9.9.0",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "28.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "15.3.0",
+    "@types/eslint__js": "^8.42.3",
     "@types/jest": "^29.5.11",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
     "brotli-size": "^4.0.0",
-    "eslint": "^8.56.0",
+    "eslint": "^9.9.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^27.6.3",
-    "eslint-plugin-tsdoc": "^0.2.17",
+    "eslint-plugin-jest": "^28.8.0",
+    "eslint-plugin-tsdoc": "^0.3.0",
+    "globals": "^15.9.0",
     "gzip-size": "^6.0.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
@@ -104,7 +105,8 @@
     "shx": "^0.3.2",
     "ts-jest": "^29.2.5",
     "typedoc": "^0.26.7",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^8.2.0"
   },
   "packageManager": "[email protected]"
 }

package.json

@@ -403,7 +403,7 @@ class Client {
       const url = `health`;
       await this.httpRequest.get(url);
       return true;
-    } catch (e: any) {
+    } catch {
       return false;
     }
   }

src/clients/client.ts

@@ -33,8 +33,8 @@ function constructHostURL(host: string): string {
     host = addProtocolIfNotPresent(host);
     host = addTrailingSlash(host);
     return host;
-  } catch (e) {
-    throw new MeiliSearchError("The provided host is not valid.");
+  } catch {
+    throw new MeiliSearchError('The provided host is not valid.');
   }
 }
 
@@ -105,8 +105,8 @@ class HttpRequests {
     try {
       const host = constructHostURL(config.host);
       this.url = new URL(host);
-    } catch (e) {
-      throw new MeiliSearchError("The provided host is not valid.");
+    } catch {
+      throw new MeiliSearchError('The provided host is not valid.');
     }
   }
 

src/http-requests.ts

@@ -24,8 +24,6 @@ export type Pagination = {
   limit?: number;
 };
 
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
 export type ResourceQuery = Pagination & {};
 
 export type ResourceResults<T> = Pagination & {
@@ -48,12 +46,8 @@ export type IndexObject = {
   updatedAt: Date;
 };
 
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
 export type IndexesQuery = ResourceQuery & {};
 
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
 export type IndexesResults<T> = ResourceResults<T> & {};
 
 /*
@@ -529,12 +523,10 @@ export type TasksQuery = {
   limit?: number;
   from?: number;
 };
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type CancelTasksQuery = Omit<TasksQuery, "limit" | "from"> & {};
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type DeleteTasksQuery = Omit<TasksQuery, "limit" | "from"> & {};
+
+export type CancelTasksQuery = Omit<TasksQuery, 'limit' | 'from'> & {};
+
+export type DeleteTasksQuery = Omit<TasksQuery, 'limit' | 'from'> & {};
 
 export type EnqueuedTaskObject = {
   taskUid: number;
@@ -684,12 +676,8 @@ export type KeyUpdate = {
   description?: string;
 };
 
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
 export type KeysQuery = ResourceQuery & {};
 
-// TODO fix
-// eslint-disable-next-line @typescript-eslint/ban-types
 export type KeysResults = ResourceResults<Key[]> & {};
 
 /*