build: fix dependencies as detected by eslint import/no-extraneous-dependencies

rhyslbw · rhyslbw · commit 75108d919578 · 2022-11-08T14:42:50.000+11:00
This rule, with the configuration to specify test files, ensures packages used in `src` are listed in the package.json `dependencies`. It will fail if missing or if the dependency is included with `devDependencies`. Development dependencies are checked against the test directories. There's a single disable as it's complaining about transitive dependency on `@types/pg` missing from `dependencies`. We can see if the feature added in import-js/eslint-plugin-import#2543 handles this scenario once released.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -24,6 +24,7 @@ module.exports = {
     'consistent-return': 0,
     // eslint compains about TS enums hence disable here and enable @typescript-eslint/no-shadow
     'import/no-unresolved': 0,
+    'import/no-extraneous-dependencies': ['error', { devDependencies: ['**/test/**/*.ts'] }],
     'jsdoc/require-param': 0,
     'jsdoc/require-param-type': 0,
     'jsdoc/require-returns': 0,
diff --git a/packages/cardano-services-client/package.json b/packages/cardano-services-client/package.json
@@ -68,7 +68,8 @@
     "@cardano-sdk/util": "^0.6.0",
     "axios": "^0.27.2",
     "class-validator": "^0.13.1",
-    "json-bigint": "~1.0.0"
+    "json-bigint": "~1.0.0",
+    "ts-log": "^2.2.4"
   },
   "files": [
     "dist/*",
diff --git a/packages/cardano-services/package.json b/packages/cardano-services/package.json
@@ -61,6 +61,7 @@
     "tscNoEmit": "shx echo typescript --noEmit command not implemented yet"
   },
   "devDependencies": {
+    "@cardano-ogmios/client": "5.5.5",
     "@cardano-sdk/cardano-services-client": "^0.6.0",
     "@cardano-sdk/util-dev": "^0.5.0",
     "@types/amqplib": "^0.8.2",
@@ -73,7 +74,6 @@
     "@types/lodash": "^4.14.182",
     "@types/pg": "^8.6.5",
     "@types/wait-on": "^5.3.1",
-    "axios": "^0.27.2",
     "cbor": "^8.1.0",
     "dockerode": "^3.3.1",
     "dockerode-utils": "^0.0.7",
@@ -95,6 +95,8 @@
     "@cardano-sdk/ogmios": "^0.6.0",
     "@cardano-sdk/util": "^0.6.0",
     "amqplib": "^0.10.0",
+    "axios": "^0.27.2",
+    "bignumber.js": "^9.1.0",
     "body-parser": "^1.19.2",
     "bunyan": "^1.8.15",
     "clear": "^0.1.0",
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -56,18 +56,19 @@
     "npm-run-all": "^4.1.5",
     "shx": "^0.3.3",
     "ts-jest": "^28.0.7",
-    "ts-log": "2.2.4",
     "typescript": "^4.7.4"
   },
   "dependencies": {
     "@cardano-ogmios/client": "5.5.5",
+    "@cardano-ogmios/schema": "5.5.5",
     "@cardano-sdk/util": "^0.6.0",
     "@dcspark/cardano-multiplatform-lib-browser": "^3.1.0",
     "@dcspark/cardano-multiplatform-lib-nodejs": "^3.1.0",
     "@emurgo/cip14-js": "^3.0.1",
     "bech32": "^2.0.0",
     "lodash": "^4.17.21",
-    "ts-custom-error": "^3.2.0"
+    "ts-custom-error": "^3.2.0",
+    "ts-log": "^2.2.4"
   },
   "files": [
     "dist/*",
diff --git a/packages/core/test/CardanoNode/mocks.ts b/packages/core/test/CardanoNode/mocks.ts
@@ -1,4 +1,4 @@
-import { Cardano, EraSummary, HealthCheckResponse, StakeDistribution } from '@cardano-sdk/core';
+import { Cardano, EraSummary, HealthCheckResponse, StakeDistribution } from '../../src';
 
 const mockEraSummaries: EraSummary[] = [
   { parameters: { epochLength: 21_600, slotLength: 20_000 }, start: { slot: 0, time: new Date(1_563_999_616_000) } },
diff --git a/packages/core/test/CardanoNode/util/stakeDistribution.test.ts b/packages/core/test/CardanoNode/util/stakeDistribution.test.ts
@@ -1,4 +1,4 @@
-import { Cardano, CardanoNodeUtil } from '@cardano-sdk/core';
+import { Cardano, CardanoNodeUtil } from '../../../src';
 import { mockStakeDistribution } from '../mocks';
 
 describe('stakeDistribution', () => {
diff --git a/packages/dapp-connector/package.json b/packages/dapp-connector/package.json
@@ -51,6 +51,7 @@
     "test:debug": "DEBUG=true yarn test"
   },
   "devDependencies": {
+    "@cardano-sdk/util": "^0.6.0",
     "@types/webextension-polyfill": "^0.8.0",
     "eslint": "^7.32.0",
     "jest": "^28.1.3",
@@ -65,7 +66,7 @@
   "dependencies": {
     "@cardano-sdk/core": "^0.6.0",
     "ts-custom-error": "^3.2.0",
-    "ts-log": "^2.2.3",
+    "ts-log": "^2.2.4",
     "webextension-polyfill": "^0.8.0"
   },
   "files": [
diff --git a/packages/e2e/package.json b/packages/e2e/package.json
@@ -72,15 +72,18 @@
     "@cardano-sdk/cardano-services": "^0.6.0",
     "@cardano-sdk/cardano-services-client": "^0.6.0",
     "@cardano-sdk/core": "^0.6.0",
+    "@cardano-sdk/key-management": "^0.2.0",
     "@cardano-sdk/ogmios": "^0.6.0",
     "@cardano-sdk/util": "^0.6.0",
+    "@cardano-sdk/util-dev": "^0.5.0",
     "@cardano-sdk/util-rxjs": "^0.4.2",
     "@cardano-sdk/wallet": "^0.6.0",
     "axios": "^0.27.2",
     "bunyan": "^1.8.15",
     "cardano-wallet-js": "^1.4.0",
     "dotenv": "^16.0.1",
     "envalid": "^7.3.1",
+    "get-port-please": "^2.5.0",
     "lodash": "^4.17.21",
     "optionator": "^0.9.1",
     "rxjs": "^7.4.0",
@@ -96,7 +99,6 @@
     "@babel/preset-env": "^7.18.2",
     "@babel/preset-typescript": "^7.17.12",
     "@cardano-sdk/dapp-connector": "^0.6.0",
-    "@cardano-sdk/util-dev": "^0.5.0",
     "@cardano-sdk/web-extension": "^0.6.0",
     "@dcspark/cardano-multiplatform-lib-asmjs": "^3.1.0",
     "@emurgo/cardano-message-signing-asmjs": "^1.0.1",
diff --git a/packages/e2e/src/tsconfig.json b/packages/e2e/src/tsconfig.json
@@ -7,6 +7,18 @@
     {
       "path": "../../cardano-services/src"
     },
+    {
+      "path": "../../cardano-services-client/src"
+    },
+    {
+      "path": "../../core/src"
+    },
+    {
+      "path": "../../key-management/src"
+    },
+    {
+      "path": "../../ogmios/src"
+    },
     {
       "path": "../../util-dev/src"
     },
diff --git a/packages/e2e/src/util/is-local-network-ready.ts b/packages/e2e/src/util/is-local-network-ready.ts
@@ -1,6 +1,8 @@
 /* eslint-disable no-console */
 /* eslint-disable @typescript-eslint/no-floating-promises */
 import * as Process from 'process';
+// This disable may not be require once https://github.com/import-js/eslint-plugin-import/pull/2543 is released.
+// eslint-disable-next-line import/no-extraneous-dependencies
 import { Pool, QueryResult } from 'pg';
 
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
diff --git a/packages/golden-test-generator/src/tsconfig.json b/packages/golden-test-generator/src/tsconfig.json
@@ -7,6 +7,9 @@
     {
       "path": "../../core/src"
     },
+    {
+      "path": "../../ogmios/src"
+    },
     {
       "path": "../../util/src"
     }
diff --git a/packages/governance/package.json b/packages/governance/package.json
@@ -58,6 +58,7 @@
   "dependencies": {
     "@cardano-sdk/core": "^0.6.0",
     "@cardano-sdk/key-management": "^0.2.0",
+    "@cardano-sdk/util": "^0.6.0",
     "blake2b": "^2.1.4"
   },
   "files": [
diff --git a/packages/key-management/package.json b/packages/key-management/package.json
@@ -63,12 +63,14 @@
     "@ledgerhq/hw-transport": "^6.27.2",
     "@ledgerhq/hw-transport-node-hid-noevents": "^6.27.2",
     "@ledgerhq/hw-transport-webhid": "^6.27.2",
+    "bip39": "^3.0.4",
     "chacha": "^2.1.0",
     "get-random-values": "^2.0.0",
     "lodash": "^4.17.21",
     "pbkdf2": "^3.1.2",
     "rxjs": "^7.4.0",
-    "trezor-connect": "8.2.11-extended"
+    "trezor-connect": "8.2.11-extended",
+    "ts-custom-error": "^3.2.0"
   },
   "files": [
     "dist/*",
diff --git a/packages/util/package.json b/packages/util/package.json
@@ -57,15 +57,15 @@
     "jest": "^28.1.3",
     "npm-run-all": "^4.1.5",
     "shx": "^0.3.3",
-    "ts-custom-error": "^3.2.0",
     "ts-jest": "^28.0.7",
-    "type-fest": "^2.19.0",
     "typescript": "^4.7.4"
   },
   "dependencies": {
     "lodash": "^4.17.21",
     "serialize-error": "^8",
-    "ts-log": "^2.2.4"
+    "ts-custom-error": "^3.2.0",
+    "ts-log": "^2.2.4",
+    "type-fest": "^2.19.0"
   },
   "files": [
     "dist/*",
diff --git a/packages/wallet/package.json b/packages/wallet/package.json
@@ -52,6 +52,7 @@
     "test:e2e": "shx echo 'test:e2e' command not implemented yet"
   },
   "devDependencies": {
+    "@cardano-foundation/ledgerjs-hw-app-cardano": "^5.0.0",
     "@cardano-ogmios/client": "5.5.5",
     "@cardano-sdk/ogmios": "^0.6.0",
     "@cardano-sdk/util-dev": "^0.5.0",
diff --git a/packages/web-extension/package.json b/packages/web-extension/package.json
@@ -73,6 +73,7 @@
     "@cardano-sdk/util-rxjs": "^0.4.2",
     "lodash": "^4.17.21",
     "rxjs": "^7.4.0",
+    "ts-custom-error": "^3.2.0",
     "ts-log": "^2.2.3",
     "uuid": "^8.3.2",
     "webextension-polyfill": "^0.8.0"
diff --git a/yarn-project.nix b/yarn-project.nix
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Cardano, EraSummary, HealthCheckResponse, StakeDistribution } from '@cardano-sdk/core';`
	`1`	`+import { Cardano, EraSummary, HealthCheckResponse, StakeDistribution } from '../../src';`
`2`	`2`
`3`	`3`	`const mockEraSummaries: EraSummary[] = [`
`4`	`4`	`{ parameters: { epochLength: 21_600, slotLength: 20_000 }, start: { slot: 0, time: new Date(1_563_999_616_000) } },`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Cardano, CardanoNodeUtil } from '@cardano-sdk/core';`
	`1`	`+import { Cardano, CardanoNodeUtil } from '../../../src';`
`2`	`2`	`import { mockStakeDistribution } from '../mocks';`
`3`	`3`
`4`	`4`	`describe('stakeDistribution', () => {`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`	`{`
`8`	`8`	`"path": "../../core/src"`
`9`	`9`	`},`
	`10`	`+ {`
	`11`	`+ "path": "../../ogmios/src"`
	`12`	`+ },`
`10`	`13`	`{`
`11`	`14`	`"path": "../../util/src"`
`12`	`15`	`}`