Enable @typescript-eslint/no-explicit-any (#3660)

This rule is disabled in our shared ESLint rules, but we want to enable
it in this repo. Since there are many, many violations at the moment,
this commit adds `eslint-ignore` directives to each violation. This way
we can prohibit the use of `any` going forward and then correct each
existing violation as we have time.

To automatically add these ignore directives, I used
[`eslint-interactive`](https://github.com/mizdra/eslint-interactive),
which is also useful for getting a quick summary of violations. This
commit also adds this tool so that we can use it going forward.

Author: mcmire

.eslintrc.js

@@ -42,6 +42,9 @@ module.exports = {
         project: ['./tsconfig.packages.json'],
       },
       rules: {
+        // Enable rules that are disabled in `@metamask/eslint-config-typescript`
+        '@typescript-eslint/no-explicit-any': 'error',
+
         // TODO: auto-fix breaks stuff
         '@typescript-eslint/promise-function-async': 'off',
 

package.json

@@ -62,6 +62,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-interactive": "^10.8.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-jest": "^27.1.5",
     "eslint-plugin-jsdoc": "^39.9.1",

packages/accounts-controller/src/AccountsController.test.ts

@@ -251,6 +251,8 @@ describe('AccountsController', () => {
             status: SnapStatus.Running,
           },
         },
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
       } as any as SnapControllerState;
       const accountsController = setupAccountsController({
         initialState: {
@@ -291,6 +293,8 @@ describe('AccountsController', () => {
             status: SnapStatus.Running,
           },
         },
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
       } as any as SnapControllerState;
       const accountsController = setupAccountsController({
         initialState: {
@@ -331,6 +335,8 @@ describe('AccountsController', () => {
             status: SnapStatus.Running,
           },
         },
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
       } as any as SnapControllerState;
       const accountsController = setupAccountsController({
         initialState: {

packages/approval-controller/src/ApprovalController.test.ts

@@ -197,6 +197,8 @@ function getApprovalCountParamsError() {
  * @returns An Error.
  */
 function getError(message: string, code?: number) {
+  // TODO: Replace `any` with type
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const err: any = {
     name: 'Error',
     message,
@@ -242,14 +244,20 @@ describe('approval controller', () => {
   describe('add', () => {
     it('validates input', () => {
       expect(() =>
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         approvalController.add({ id: null, origin: 'bar.baz' } as any),
       ).toThrow(getInvalidIdError());
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       expect(() => approvalController.add({ id: 'foo' } as any)).toThrow(
         getInvalidOriginError(),
       );
 
       expect(() =>
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         approvalController.add({ id: 'foo', origin: true } as any),
       ).toThrow(getInvalidOriginError());
 
@@ -258,6 +266,8 @@ describe('approval controller', () => {
           id: 'foo',
           origin: 'bar.baz',
           type: {},
+          // TODO: Replace `any` with type
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } as any),
       ).toThrow(getInvalidTypeError(errorCodes.rpc.internal));
 
@@ -266,6 +276,8 @@ describe('approval controller', () => {
           id: 'foo',
           origin: 'bar.baz',
           type: '',
+          // TODO: Replace `any` with type
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } as any),
       ).toThrow(getInvalidTypeError(errorCodes.rpc.internal));
 
@@ -275,6 +287,8 @@ describe('approval controller', () => {
           origin: 'bar.baz',
           type: 'type',
           requestData: 'foo',
+          // TODO: Replace `any` with type
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } as any),
       ).toThrow(getInvalidRequestDataError());
 
@@ -284,6 +298,8 @@ describe('approval controller', () => {
           origin: 'bar.baz',
           type: 'type',
           requestState: 'foo',
+          // TODO: Replace `any` with type
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
         } as any),
       ).toThrow(getInvalidRequestStateError());
     });
@@ -493,16 +509,24 @@ describe('approval controller', () => {
 
       expect(approvalController.get('fizz')).toBeUndefined();
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       expect((approvalController as any).get()).toBeUndefined();
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       expect(approvalController.get({} as any)).toBeUndefined();
     });
   });
 
   describe('getApprovalCount', () => {
+    // TODO: Replace `any` with type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let addWithCatch: (args: any) => void;
 
     beforeEach(() => {
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       addWithCatch = (args: any) => {
         approvalController.add(args).catch(() => undefined);
       };
@@ -518,10 +542,14 @@ describe('approval controller', () => {
       );
 
       expect(() =>
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         approvalController.getApprovalCount({ origin: null } as any),
       ).toThrow(getApprovalCountParamsError());
 
       expect(() =>
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         approvalController.getApprovalCount({ type: false } as any),
       ).toThrow(getApprovalCountParamsError());
     });
@@ -636,6 +664,8 @@ describe('approval controller', () => {
     it('gets the total approval count', () => {
       expect(approvalController.getTotalApprovalCount()).toBe(0);
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const addWithCatch = (args: any) => {
         approvalController.add(args).catch(() => undefined);
       };
@@ -664,6 +694,8 @@ describe('approval controller', () => {
       });
       expect(approvalController.getTotalApprovalCount()).toBe(0);
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const addWithCatch = (args: any) => {
         approvalController.add(args).catch(() => undefined);
       };
@@ -692,19 +724,27 @@ describe('approval controller', () => {
         getInvalidHasParamsError(),
       );
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       expect(() => approvalController.has({ id: true } as any)).toThrow(
         getInvalidHasIdError(),
       );
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       expect(() => approvalController.has({ origin: true } as any)).toThrow(
         getInvalidHasOriginError(),
       );
 
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       expect(() => approvalController.has({ type: true } as any)).toThrow(
         getInvalidHasTypeError(),
       );
 
       expect(() =>
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         approvalController.has({ origin: 'foo', type: true } as any),
       ).toThrow(getInvalidHasTypeError());
     });
@@ -1341,6 +1381,8 @@ describe('approval controller', () => {
      * @param methodCallback - A callback to invoke the result method.
      */
     async function endsSpecifiedFlowTemplate(
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       methodCallback: (flowId: string) => Promise<any>,
     ) {
       approvalController.startFlow({ id: FLOW_ID_MOCK });
@@ -1365,6 +1407,8 @@ describe('approval controller', () => {
      * @param methodCallback - A callback to invoke the result method.
      */
     async function doesNotThrowIfAddingRequestFails(
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       methodCallback: () => Promise<any>,
     ) {
       jest.spyOn(global.console, 'info');
@@ -1389,6 +1433,8 @@ describe('approval controller', () => {
      * @param methodCallback - A callback to invoke the result method.
      */
     async function doesNotThrowIfEndFlowFails(
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       methodCallback: () => Promise<any>,
     ) {
       jest.spyOn(global.console, 'info');
@@ -1425,6 +1471,8 @@ describe('approval controller', () => {
       });
 
       it('only includes relevant options in request data', async () => {
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         (approvalController as any).success({
           ...SUCCESS_OPTIONS_MOCK,
           extra: 'testValue',
@@ -1483,6 +1531,8 @@ describe('approval controller', () => {
       });
 
       it('only includes relevant options in request data', async () => {
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         (approvalController as any).error({
           ...ERROR_OPTIONS_MOCK,
           extra: 'testValue',

packages/approval-controller/src/ApprovalController.ts

@@ -751,6 +751,8 @@ export class ApprovalController extends BaseController<
     this.update((draftState) => {
       // Typecast: ts(2589)
       draftState.pendingApprovals[opts.id].requestState =
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         opts.requestState as any;
     });
   }
@@ -839,6 +841,8 @@ export class ApprovalController extends BaseController<
     await this.#result(APPROVAL_TYPE_RESULT_SUCCESS, opts, {
       message: opts.message,
       header: opts.header,
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } as any);
     return {};
   }
@@ -856,6 +860,8 @@ export class ApprovalController extends BaseController<
     await this.#result(APPROVAL_TYPE_RESULT_ERROR, opts, {
       error: opts.error,
       header: opts.header,
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } as any);
     return {};
   }
@@ -998,6 +1004,8 @@ export class ApprovalController extends BaseController<
 
     this.update((draftState) => {
       // Typecast: ts(2589)
+      // TODO: Replace `any` with type
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       draftState.pendingApprovals[id] = approval as any;
       draftState.pendingApprovalCount = Object.keys(
         draftState.pendingApprovals,

packages/assets-controllers/src/AccountTrackerController.test.ts

@@ -86,6 +86,8 @@ describe('AccountTrackerController', () => {
     controller.refresh = sinon.stub();
 
     preferences.setFeatureFlag('foo', true);
+    // TODO: Replace `any` with type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     expect((controller.refresh as any).called).toBe(true);
   });
 

packages/assets-controllers/src/AssetsContractController.test.ts

@@ -73,6 +73,8 @@ async function setupAssetContractControllers() {
       ({
         ...network.getNetworkClientById(networkClientId),
         provider,
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
       } as any),
   });
 

packages/assets-controllers/src/AssetsContractController.ts

@@ -62,6 +62,8 @@ export const MISSING_PROVIDER_ERROR =
 // Convert to a `type` in a future major version.
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface AssetsContractConfig extends BaseConfig {
+  // TODO: Replace `any` with type
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   provider: any;
   ipfsGateway: string;
   chainId: Hex;
@@ -87,6 +89,8 @@ export class AssetsContractController extends BaseControllerV1<
   AssetsContractConfig,
   BaseState
 > {
+  // TODO: Replace `any` with type
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private _provider?: any;
 
   /**
@@ -155,6 +159,8 @@ export class AssetsContractController extends BaseControllerV1<
    *
    * @property provider - Provider used to create a new underlying Web3 instance
    */
+  // TODO: Replace `any` with type
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   set provider(provider: any) {
     this._provider = provider;
   }