chore: Fix all auto-fixable ESLint warnings (#7105)

## Explanation

Fix all auto-fixable ESLint warnings. These changes were generated by
running `yarn eslint --fix`.

There were a number of blank JSDoc entries added by the initial auto-fix
command, which had to be reverted because the empty blocks generated
errors. The JSDoc auto-fix rules also messed up some of our malformated
type doc blocks, which were reverted as well (the current invalid syntax
isn't good, but we should at least preserve it until we can fix it
properly).

I also had to do a manual pass to remove obsolete comments and extra
newlines from the auto-fix rule that removed unused ESLint ignore
directives.

Aside from that, everything else ESLint recognized as auto-fixable seems
to have been fixed correctly.

## References

N/A

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Repo-wide ESLint autofixes: mark private fields as readonly, reorder
imports, clean/adjust ESLint disables and JSDoc, switch some re-exports
to type-only, and update lint warning thresholds; no functional changes.
> 
> - **Codebase-wide ESLint autofixes**:
> - Mark many private fields as `readonly` (e.g., in
`ApprovalController`, `RatesController`, `TokenRatesController`,
`NameController`, various providers/controllers/tests).
>   - Reorder/normalize imports across numerous files and tests.
> - Remove or relocate obsolete `eslint-disable` comments; trim extra
newlines and comments.
> - JSDoc tidying: add missing spacing, brief descriptions, and param
docs; remove empty/malformed blocks.
> - Convert some re-exports to type-only (e.g.,
`logging-controller/src/logTypes/index.ts`,
`message-manager/src/index.ts`).
>   - Minor string/template/comment fixes to satisfy lint rules.
> - **Config/metadata**:
> - Update `eslint-warning-thresholds.json` to reflect fewer rule
violations.
> - **Tests/Utilities**:
> - Align tests and helpers with import/order and readonly changes;
minor noop function/type tweaks.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
cf8849f. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Maarten Zuidhoorn <[email protected]>

Author: Gudahtt

eslint-warning-thresholds.json

@@ -6,12 +6,8 @@
     "@typescript-eslint/no-unsafe-enum-comparison": 8
   },
   "packages/approval-controller/src/ApprovalController.test.ts": {
-    "import-x/order": 1,
     "jest/no-conditional-in-test": 16
   },
-  "packages/approval-controller/src/ApprovalController.ts": {
-    "@typescript-eslint/prefer-readonly": 4
-  },
   "packages/assets-controllers/jest.environment.js": {
     "n/prefer-global/text-encoder": 1,
     "n/prefer-global/text-decoder": 1,
@@ -46,34 +42,17 @@
     "@typescript-eslint/no-misused-promises": 2
   },
   "packages/assets-controllers/src/NftDetectionController.test.ts": {
-    "import-x/namespace": 6,
-    "import-x/order": 3
+    "import-x/namespace": 6
   },
   "packages/assets-controllers/src/NftDetectionController.ts": {
-    "jsdoc/check-tag-names": 34,
-    "jsdoc/tag-lines": 1
-  },
-  "packages/assets-controllers/src/RatesController/RatesController.test.ts": {
-    "import-x/order": 1,
-    "jsdoc/tag-lines": 2
-  },
-  "packages/assets-controllers/src/RatesController/RatesController.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "import-x/order": 1,
-    "jsdoc/tag-lines": 3
-  },
-  "packages/assets-controllers/src/RatesController/types.ts": {
-    "import-x/order": 1
+    "jsdoc/check-tag-names": 34
   },
   "packages/assets-controllers/src/Standards/ERC20Standard.test.ts": {
     "jest/no-commented-out-tests": 1
   },
   "packages/assets-controllers/src/Standards/NftStandards/ERC1155/ERC1155Standard.test.ts": {
     "import-x/no-named-as-default-member": 1
   },
-  "packages/assets-controllers/src/Standards/NftStandards/ERC721/ERC721Standard.ts": {
-    "prettier/prettier": 1
-  },
   "packages/assets-controllers/src/TokenBalancesController.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },
@@ -82,45 +61,31 @@
   },
   "packages/assets-controllers/src/TokenListController.test.ts": {
     "import-x/namespace": 7,
-    "import-x/order": 2,
     "jest/no-conditional-in-test": 2
   },
   "packages/assets-controllers/src/TokenRatesController.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
     "jsdoc/check-tag-names": 11
   },
   "packages/assets-controllers/src/TokensController.test.ts": {
     "import-x/namespace": 1,
-    "import-x/order": 3,
     "jest/no-conditional-in-test": 2
   },
   "packages/assets-controllers/src/TokensController.ts": {
     "@typescript-eslint/no-unused-vars": 1,
-    "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/check-tag-names": 10,
-    "jsdoc/tag-lines": 2
+    "jsdoc/check-tag-names": 10
   },
   "packages/assets-controllers/src/assetsUtil.test.ts": {
     "jest/no-conditional-in-test": 2
   },
-  "packages/assets-controllers/src/assetsUtil.ts": {
-    "jsdoc/tag-lines": 2
-  },
   "packages/assets-controllers/src/multicall.test.ts": {
     "@typescript-eslint/prefer-promise-reject-errors": 2
   },
-  "packages/assets-controllers/src/token-prices-service/codefi-v2.ts": {
-    "jsdoc/tag-lines": 2
-  },
   "packages/base-controller/src/BaseController.test.ts": {
     "import-x/namespace": 13
   },
   "packages/bridge-status-controller/src/utils/transaction.ts": {
     "@typescript-eslint/no-unsafe-enum-comparison": 2
   },
-  "packages/build-utils/src/transforms/remove-fenced-code.test.ts": {
-    "import-x/order": 1
-  },
   "packages/build-utils/src/transforms/remove-fenced-code.ts": {
     "@typescript-eslint/no-unsafe-enum-comparison": 1
   },
@@ -136,9 +101,6 @@
     "@typescript-eslint/no-unused-vars": 1,
     "jsdoc/check-tag-names": 5
   },
-  "packages/controller-utils/src/types.ts": {
-    "jsdoc/tag-lines": 1
-  },
   "packages/controller-utils/src/util.test.ts": {
     "import-x/no-named-as-default": 1,
     "jest/no-conditional-in-test": 1,
@@ -153,9 +115,6 @@
   "packages/eip-5792-middleware/src/hooks/processSendCalls.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },
-  "packages/ens-controller/src/EnsController.test.ts": {
-    "import-x/order": 1
-  },
   "packages/ens-controller/src/EnsController.ts": {
     "jsdoc/check-tag-names": 6
   },
@@ -260,15 +219,10 @@
     "jsdoc/match-description": 11
   },
   "packages/gas-fee-controller/src/GasFeeController.test.ts": {
-    "import-x/namespace": 2,
-    "import-x/order": 1
+    "import-x/namespace": 2
   },
   "packages/gas-fee-controller/src/GasFeeController.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/check-tag-names": 21
-  },
-  "packages/gas-fee-controller/src/determineGasFeeCalculations.ts": {
-    "jsdoc/tag-lines": 4
+    "jsdoc/check-tag-names": 20
   },
   "packages/json-rpc-middleware-stream/src/index.test.ts": {
     "@typescript-eslint/prefer-promise-reject-errors": 1,
@@ -285,24 +239,17 @@
     "@typescript-eslint/no-unsafe-enum-comparison": 2,
     "@typescript-eslint/no-unused-vars": 1
   },
-  "packages/keyring-controller/tests/mocks/mockKeyring.ts": {
-    "@typescript-eslint/prefer-readonly": 1
-  },
   "packages/logging-controller/src/LoggingController.test.ts": {
     "import-x/namespace": 1
   },
   "packages/logging-controller/src/LoggingController.ts": {
     "jsdoc/check-tag-names": 1
   },
-  "packages/logging-controller/src/logTypes/index.ts": {
-    "@typescript-eslint/consistent-type-exports": 1
-  },
   "packages/message-manager/src/AbstractMessageManager.test.ts": {
     "jest/no-conditional-in-test": 7
   },
   "packages/message-manager/src/AbstractMessageManager.ts": {
-    "jsdoc/check-tag-names": 25,
-    "jsdoc/tag-lines": 2
+    "jsdoc/check-tag-names": 25
   },
   "packages/message-manager/src/DecryptMessageManager.test.ts": {
     "jest/no-conditional-in-test": 3
@@ -316,9 +263,6 @@
   "packages/message-manager/src/EncryptionPublicKeyManager.ts": {
     "jsdoc/check-tag-names": 13
   },
-  "packages/message-manager/src/index.ts": {
-    "@typescript-eslint/consistent-type-exports": 1
-  },
   "packages/message-manager/src/utils.ts": {
     "@typescript-eslint/no-unused-vars": 1
   },
@@ -329,32 +273,7 @@
     "@typescript-eslint/no-misused-promises": 2
   },
   "packages/name-controller/src/NameController.ts": {
-    "@typescript-eslint/no-unsafe-enum-comparison": 1,
-    "@typescript-eslint/prefer-readonly": 2
-  },
-  "packages/name-controller/src/providers/ens.test.ts": {
-    "import-x/order": 1
-  },
-  "packages/name-controller/src/providers/ens.ts": {
-    "@typescript-eslint/prefer-readonly": 2
-  },
-  "packages/name-controller/src/providers/etherscan.test.ts": {
-    "import-x/order": 1
-  },
-  "packages/name-controller/src/providers/etherscan.ts": {
-    "@typescript-eslint/prefer-readonly": 2
-  },
-  "packages/name-controller/src/providers/lens.test.ts": {
-    "import-x/order": 1
-  },
-  "packages/name-controller/src/providers/lens.ts": {
-    "@typescript-eslint/prefer-readonly": 1
-  },
-  "packages/name-controller/src/providers/token.test.ts": {
-    "import-x/order": 1
-  },
-  "packages/name-controller/src/providers/token.ts": {
-    "@typescript-eslint/prefer-readonly": 1
+    "@typescript-eslint/no-unsafe-enum-comparison": 1
   },
   "packages/name-controller/src/util.ts": {
     "jsdoc/require-returns": 1
@@ -368,16 +287,8 @@
   "packages/permission-controller/src/PermissionController.test.ts": {
     "jest/no-conditional-in-test": 4
   },
-  "packages/permission-controller/src/rpc-methods/getPermissions.test.ts": {
-    "import-x/order": 1
-  },
-  "packages/permission-controller/src/rpc-methods/requestPermissions.ts": {
-    "prettier/prettier": 1
-  },
   "packages/permission-log-controller/src/PermissionLogController.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/check-tag-names": 2,
-    "jsdoc/tag-lines": 1
+    "jsdoc/check-tag-names": 2
   },
   "packages/phishing-controller/src/PhishingController.ts": {
     "jsdoc/check-tag-names": 32
@@ -388,28 +299,12 @@
   "packages/phishing-controller/src/utils.ts": {
     "@typescript-eslint/no-unsafe-enum-comparison": 1
   },
-  "packages/polling-controller/src/AbstractPollingController.ts": {
-    "@typescript-eslint/prefer-readonly": 1
-  },
   "packages/rate-limit-controller/src/RateLimitController.ts": {
     "jsdoc/check-tag-names": 4
   },
   "packages/remote-feature-flag-controller/src/client-config-api-service/client-config-api-service.test.ts": {
-    "import-x/order": 1,
-    "jsdoc/tag-lines": 1,
     "promise/param-names": 1
   },
-  "packages/remote-feature-flag-controller/src/client-config-api-service/client-config-api-service.ts": {
-    "@typescript-eslint/prefer-readonly": 4,
-    "jsdoc/tag-lines": 2
-  },
-  "packages/remote-feature-flag-controller/src/remote-feature-flag-controller.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/check-tag-names": 2
-  },
-  "packages/remote-feature-flag-controller/src/utils/user-segmentation-utils.ts": {
-    "jsdoc/tag-lines": 2
-  },
   "packages/sample-controllers/src/sample-gas-prices-controller.ts": {
     "@typescript-eslint/no-misused-promises": 1
   },
@@ -441,85 +336,30 @@
     "@typescript-eslint/no-base-to-string": 1,
     "@typescript-eslint/no-unused-vars": 2
   },
-  "packages/user-operation-controller/src/UserOperationController.test.ts": {
-    "jsdoc/tag-lines": 4
-  },
   "packages/user-operation-controller/src/UserOperationController.ts": {
     "@typescript-eslint/prefer-promise-reject-errors": 1,
-    "@typescript-eslint/prefer-readonly": 3,
     "jsdoc/require-returns": 2
   },
   "packages/user-operation-controller/src/helpers/Bundler.test.ts": {
-    "import-x/order": 1,
-    "jsdoc/require-returns": 1,
-    "jsdoc/tag-lines": 1
-  },
-  "packages/user-operation-controller/src/helpers/Bundler.ts": {
-    "@typescript-eslint/prefer-readonly": 1,
-    "jsdoc/tag-lines": 2
-  },
-  "packages/user-operation-controller/src/helpers/PendingUserOperationTracker.test.ts": {
-    "import-x/order": 2,
-    "jsdoc/tag-lines": 4,
-    "prettier/prettier": 1
-  },
-  "packages/user-operation-controller/src/helpers/PendingUserOperationTracker.ts": {
-    "@typescript-eslint/prefer-readonly": 2,
-    "import-x/order": 1
-  },
-  "packages/user-operation-controller/src/helpers/SnapSmartContractAccount.test.ts": {
-    "import-x/order": 1,
-    "jsdoc/tag-lines": 1
-  },
-  "packages/user-operation-controller/src/helpers/SnapSmartContractAccount.ts": {
-    "@typescript-eslint/prefer-readonly": 1
-  },
-  "packages/user-operation-controller/src/types.ts": {
-    "jsdoc/tag-lines": 3
-  },
-  "packages/user-operation-controller/src/utils/gas-fees.ts": {
-    "jsdoc/tag-lines": 7
-  },
-  "packages/user-operation-controller/src/utils/gas.test.ts": {
-    "import-x/order": 1,
-    "jsdoc/tag-lines": 1
-  },
-  "packages/user-operation-controller/src/utils/gas.ts": {
-    "jsdoc/tag-lines": 2
-  },
-  "packages/user-operation-controller/src/utils/transaction.test.ts": {
-    "import-x/order": 1
-  },
-  "packages/user-operation-controller/src/utils/transaction.ts": {
-    "jsdoc/tag-lines": 2
-  },
-  "packages/user-operation-controller/src/utils/validation.test.ts": {
-    "import-x/order": 1,
-    "jsdoc/tag-lines": 2
-  },
-  "packages/user-operation-controller/src/utils/validation.ts": {
-    "jsdoc/tag-lines": 8
+    "jsdoc/require-returns": 1
   },
   "scripts/create-package/utils.test.ts": {
     "@typescript-eslint/no-unsafe-enum-comparison": 3,
     "import-x/no-named-as-default-member": 2,
     "jest/no-conditional-in-test": 1
   },
   "scripts/create-package/utils.ts": {
-    "@typescript-eslint/no-unsafe-enum-comparison": 5,
-    "prettier/prettier": 1
+    "@typescript-eslint/no-unsafe-enum-comparison": 5
   },
   "tests/fake-block-tracker.ts": {
     "no-empty-function": 1
   },
   "tests/fake-provider.ts": {
     "@typescript-eslint/prefer-promise-reject-errors": 1,
-    "@typescript-eslint/prefer-readonly": 2,
     "jsdoc/check-tag-names": 12
   },
   "tests/mock-network.ts": {
     "@typescript-eslint/no-unsafe-enum-comparison": 1,
-    "@typescript-eslint/prefer-readonly": 3,
     "jsdoc/check-tag-names": 10
   },
   "tests/setupAfterEnv/nock.ts": {

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

@@ -11,7 +11,6 @@ import {
 import { errorCodes, JsonRpcError } from '@metamask/rpc-errors';
 import { nanoid } from 'nanoid';
 
-import { flushPromises } from '../../../tests/helpers';
 import type {
   AddApprovalOptions,
   ApprovalControllerActions,
@@ -33,6 +32,7 @@ import {
   MissingApprovalFlowError,
   NoApprovalFlowsError,
 } from './errors';
+import { flushPromises } from '../../../tests/helpers';
 
 jest.mock('nanoid');
 

packages/approval-controller/src/ApprovalController.ts

@@ -369,13 +369,13 @@ export class ApprovalController extends BaseController<
   ApprovalControllerState,
   ApprovalControllerMessenger
 > {
-  #approvals: Map<string, ApprovalCallbacks>;
+  readonly #approvals: Map<string, ApprovalCallbacks>;
 
-  #origins: Map<string, Map<string, number>>;
+  readonly #origins: Map<string, Map<string, number>>;
 
-  #showApprovalRequest: () => void;
+  readonly #showApprovalRequest: () => void;
 
-  #typesExcludedFromRateLimiting: string[];
+  readonly #typesExcludedFromRateLimiting: string[];
 
   /**
    * Construct an Approval controller.
@@ -615,8 +615,6 @@ export class ApprovalController extends BaseController<
     if (origin) {
       return Array.from(
         (this.#origins.get(origin) || new Map()).values(),
-        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-        // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
       ).reduce((total, value) => total + value, 0);
     }