refactor: Fix most lint exceptions

Author: rekmarks

eslint-warning-thresholds.json

@@ -154,29 +154,7 @@
     "@typescript-eslint/no-explicit-any": 1
   },
   "packages/eth-json-rpc-middleware/src/block-cache.ts": {
-    "jsdoc/require-jsdoc": 1,
-    "no-restricted-syntax": 1
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref-rewrite.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref.test.ts": {
-    "jest/expect-expect": 2
-  },
-  "packages/eth-json-rpc-middleware/src/block-ref.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/block-tracker-inspector.ts": {
-    "jsdoc/match-description": 2
-  },
-  "packages/eth-json-rpc-middleware/src/fetch.test.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/fetch.ts": {
-    "jsdoc/match-description": 1
-  },
-  "packages/eth-json-rpc-middleware/src/inflight-cache.ts": {
-    "jsdoc/match-description": 4
+    "jsdoc/require-jsdoc": 1
   },
   "packages/eth-json-rpc-middleware/src/methods/wallet-request-execution-permissions.ts": {
     "jsdoc/require-jsdoc": 1
@@ -187,43 +165,15 @@
   "packages/eth-json-rpc-middleware/src/providerAsMiddleware.ts": {
     "jsdoc/require-jsdoc": 2
   },
-  "packages/eth-json-rpc-middleware/src/retryOnEmpty.test.ts": {
-    "jsdoc/match-description": 3
-  },
-  "packages/eth-json-rpc-middleware/src/retryOnEmpty.ts": {
-    "jsdoc/match-description": 2
-  },
-  "packages/eth-json-rpc-middleware/src/utils/cache.ts": {
-    "jsdoc/match-description": 6
-  },
-  "packages/eth-json-rpc-middleware/src/utils/common.ts": {
-    "jsdoc/match-description": 1
-  },
   "packages/eth-json-rpc-middleware/src/utils/error.ts": {
     "jsdoc/require-jsdoc": 1
   },
-  "packages/eth-json-rpc-middleware/src/utils/normalize.ts": {
-    "jsdoc/match-description": 3
-  },
-  "packages/eth-json-rpc-middleware/src/utils/timeout.ts": {
-    "jsdoc/match-description": 1
-  },
   "packages/eth-json-rpc-middleware/src/utils/validation.ts": {
     "jsdoc/require-jsdoc": 4
   },
   "packages/eth-json-rpc-middleware/src/wallet.ts": {
-    "@typescript-eslint/prefer-nullish-coalescing": 5,
-    "jsdoc/match-description": 3,
     "jsdoc/require-jsdoc": 12
   },
-  "packages/eth-json-rpc-middleware/test/setupAfterEnv.ts": {
-    "@typescript-eslint/no-explicit-any": 3,
-    "jsdoc/match-description": 2
-  },
-  "packages/eth-json-rpc-middleware/test/util/helpers.ts": {
-    "@typescript-eslint/no-explicit-any": 5,
-    "jsdoc/match-description": 10
-  },
   "packages/gas-fee-controller/src/GasFeeController.test.ts": {
     "import-x/namespace": 2,
     "import-x/order": 1

eslint.config.mjs

@@ -234,12 +234,8 @@ const config = createConfig([
   {
     files: ['packages/eth-json-rpc-middleware/**/*.ts'],
     rules: {
-      // TODO: Re-enable these rules or add inline ignores for warranted cases
-      '@typescript-eslint/no-explicit-any': 'warn',
-      '@typescript-eslint/prefer-nullish-coalescing': 'warn',
-      'jsdoc/match-description': 'warn',
+      // TODO: Re-enable this
       'jsdoc/require-jsdoc': 'warn',
-      'no-restricted-syntax': 'warn',
     },
   },
   {

packages/eth-json-rpc-middleware/src/block-cache.ts

@@ -33,19 +33,19 @@ type BlockCacheMiddlewareOptions = {
 //
 
 class BlockCacheStrategy {
-  private cache: Cache;
+  #cache: Cache;
 
   constructor() {
-    this.cache = {};
+    this.#cache = {};
   }
 
   getBlockCache(blockNumberHex: string): BlockCache {
     const blockNumber: number = Number.parseInt(blockNumberHex, 16);
-    let blockCache: BlockCache = this.cache[blockNumber];
+    let blockCache: BlockCache = this.#cache[blockNumber];
     // create new cache if necesary
     if (!blockCache) {
       const newCache: BlockCache = {};
-      this.cache[blockNumber] = newCache;
+      this.#cache[blockNumber] = newCache;
       blockCache = newCache;
     }
     return blockCache;
@@ -126,10 +126,10 @@ class BlockCacheStrategy {
   clearBefore(oldBlockHex: string): void {
     const oldBlockNumber: number = Number.parseInt(oldBlockHex, 16);
     // clear old caches
-    Object.keys(this.cache)
+    Object.keys(this.#cache)
       .map(Number)
       .filter((num) => num < oldBlockNumber)
-      .forEach((num) => delete this.cache[num]);
+      .forEach((num) => delete this.#cache[num]);
   }
 }
 

packages/eth-json-rpc-middleware/src/block-ref.test.ts

@@ -196,6 +196,8 @@ describe('createBlockRefMiddleware', () => {
         describe.each(['earliest', 'pending', '0x200'])(
           'if the block param is something other than "latest", like %o',
           (blockParam) => {
+            // Using custom expect helper
+            // eslint-disable-next-line jest/expect-expect
             it('does not make a direct request through the provider', async () => {
               const finalMiddleware = createFinalMiddlewareWithDefaultResult();
 
@@ -267,6 +269,8 @@ describe('createBlockRefMiddleware', () => {
   });
 
   describe('when the RPC method does not take a block parameter', () => {
+    // Using custom expect helper
+    // eslint-disable-next-line jest/expect-expect
     it('does not make a direct request through the provider', async () => {
       const finalMiddleware = createFinalMiddlewareWithDefaultResult();
 

packages/eth-json-rpc-middleware/test/setupAfterEnv.ts

@@ -37,7 +37,7 @@ expect.extend({
    * @param promise - The promise to test.
    * @returns The result of the matcher.
    */
-  async toNeverResolve(promise: Promise<any>) {
+  async toNeverResolve(promise: Promise<unknown>) {
     if (this.isNot) {
       throw new Error(
         'Using `.not.toNeverResolve(...)` is not supported. ' +
@@ -46,8 +46,8 @@ expect.extend({
       );
     }
 
-    let resolutionValue: any;
-    let rejectionValue: any;
+    let resolutionValue: unknown;
+    let rejectionValue: unknown;
     try {
       resolutionValue = await Promise.race([
         promise,
@@ -67,8 +67,8 @@ expect.extend({
           message: () => {
             return `Expected promise to never resolve after ${TIME_TO_WAIT_UNTIL_UNRESOLVED}ms, but it ${
               rejectionValue
-                ? `was rejected with ${rejectionValue}`
-                : `resolved with ${resolutionValue}`
+                ? `was rejected with ${JSON.stringify(rejectionValue, null, 2)}`
+                : `resolved with ${JSON.stringify(resolutionValue, null, 2)}`
             }`;
           },
           pass: false,

packages/eth-json-rpc-middleware/test/util/helpers.ts

@@ -2,7 +2,10 @@ import { PollingBlockTracker } from '@metamask/eth-block-tracker';
 import { InternalProvider } from '@metamask/eth-json-rpc-provider';
 import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import { JsonRpcEngineV2 } from '@metamask/json-rpc-engine/v2';
-import type { JsonRpcMiddleware } from '@metamask/json-rpc-engine/v2';
+import type {
+  JsonRpcMiddleware,
+  ResultConstraint,
+} from '@metamask/json-rpc-engine/v2';
 import type { Json, JsonRpcParams, JsonRpcRequest } from '@metamask/utils';
 import { klona } from 'klona/full';
 import { isDeepStrictEqual } from 'util';
@@ -113,6 +116,10 @@ export function createProviderAndBlockTracker(): {
   return { provider, blockTracker };
 }
 
+// An expedient for use with createEngine below.
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type AnyMiddleware = JsonRpcMiddleware<any, ResultConstraint<any>, any>;
+
 /**
  * Creates a JSON-RPC engine with the middleware under test and any
  * additional middleware. If no other middleware is provided, a final middleware
@@ -123,8 +130,8 @@ export function createProviderAndBlockTracker(): {
  * @returns The created engine.
  */
 export function createEngine(
-  middlewareUnderTest: JsonRpcMiddleware<any, any>,
-  ...otherMiddleware: JsonRpcMiddleware<any, any>[]
+  middlewareUnderTest: AnyMiddleware,
+  ...otherMiddleware: AnyMiddleware[]
 ): JsonRpcEngineV2 {
   return JsonRpcEngineV2.create({
     middleware: [
@@ -258,10 +265,10 @@ export function expectProviderRequestNotToHaveBeenMade(
  * @returns The Jest spy object that represents `provider.request` (so that
  * you can make assertions on the method later, if you like).
  */
-export function stubProviderRequests(
-  provider: InternalProvider,
-  stubs: ProviderRequestStub<any, Json>[],
-) {
+export function stubProviderRequests<
+  Params extends JsonRpcParams = JsonRpcParams,
+  Result extends Json = Json,
+>(provider: InternalProvider, stubs: ProviderRequestStub<Params, Result>[]) {
   const remainingStubs = klona(stubs);
   const callNumbersByRequest = new Map<Partial<JsonRpcRequest>, number>();
   return jest.spyOn(provider, 'request').mockImplementation(async (request) => {