chore: Fix development peerDependency warnings (#468)

* chore: Fix development `peerDependency` warnings The `@lavamoat/preinstall-always-fail` package has been added, and the package `eslint-plugin-import` package has been downgraded by a minor version, both to meet `peerDependency` requirements of other development dependencies. Resolves two warnings, no functional changes. * Fix import order lint errors and remove unnecessary comments * Restore necessary ts-ignore comment
MetaMask · Nov 26, 2024 · 5bdc0b3 · 5bdc0b3
1 parent cf6c4ab
commit 5bdc0b3
Show file tree

Hide file tree

Showing 5 changed files with 490 additions and 307 deletions.
diff --git a/package.json b/package.json
@@ -43,6 +43,7 @@
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^3.2.1",
+    "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.1.0",
     "@metamask/eslint-config": "^12.2.0",
     "@metamask/eslint-config-jest": "^12.1.0",
@@ -58,7 +59,7 @@
     "@typescript-eslint/parser": "^5.33.0",
     "eslint": "^8.48.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "~2.26.0",
     "eslint-plugin-jest": "^27.1.5",
     "eslint-plugin-jsdoc": "^39.2.9",
     "eslint-plugin-n": "^15.7.0",

diff --git a/src/SmartTransactionsController.test.ts b/src/SmartTransactionsController.test.ts
@@ -17,8 +17,8 @@ import {
 import nock from 'nock';
 import * as sinon from 'sinon';
 
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
+import packageJson from '../package.json';
+import { advanceTime, flushPromises, getFakeProvider } from '../tests/helpers';
 import { API_BASE_URL, SENTINEL_API_BASE_URL_MAP } from './constants';
 import SmartTransactionsController, {
   DEFAULT_INTERVAL,
@@ -33,8 +33,6 @@ import type {
 import type { SmartTransaction, UnsignedTransaction, Hex } from './types';
 import { SmartTransactionStatuses } from './types';
 import * as utils from './utils';
-import packageJson from '../package.json';
-import { advanceTime, flushPromises, getFakeProvider } from '../tests/helpers';
 
 jest.mock('@ethersproject/bytes', () => ({
   ...jest.requireActual('@ethersproject/bytes'),

diff --git a/src/utils.test.ts b/src/utils.test.ts
@@ -1,7 +1,6 @@
 import { ChainId } from '@metamask/controller-utils';
 
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
+import packageJson from '../package.json';
 import { API_BASE_URL, SENTINEL_API_BASE_URL_MAP } from './constants';
 import {
   SmartTransactionMinedTx,
@@ -10,7 +9,6 @@ import {
   SmartTransactionCancellationReason,
 } from './types';
 import * as utils from './utils';
-import packageJson from '../package.json';
 
 const createSignedTransaction = () => {
   return '0xf86c098504a817c800825208943535353535353535353535353535353535353535880de0b6b3a76400008025a02b79f322a625d623a2bb2911e0c6b3e7eaf741a7c7c5d2e8c67ef3ff4acf146ca01ae168fea63dc3391b75b586c8a7c0cb55cdf3b8e2e4d8e097957a3a56c6f2c5';

diff --git a/src/utils.ts b/src/utils.ts
@@ -5,7 +5,11 @@ import { BigNumber } from 'bignumber.js';
 import jsonDiffer from 'fast-json-patch';
 import _ from 'lodash';
 
+// Ignoring TypeScript errors here because this import is disallowed for production builds, because
+// the `package.json` file is above the root directory.
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import packageJson from '../package.json';
 import { API_BASE_URL, SENTINEL_API_BASE_URL_MAP } from './constants';
 import type { SmartTransaction, SmartTransactionsStatus } from './types';
 import {
@@ -15,9 +19,6 @@ import {
   SmartTransactionMinedTx,
   cancellationReasonToStatusMap,
 } from './types';
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import packageJson from '../package.json';
 
 export function isSmartTransactionPending(smartTransaction: SmartTransaction) {
   return smartTransaction.status === SmartTransactionStatuses.PENDING;