chore: mandate .js extensions for imports (#2128)

* feat: add eslint rule * chore: update codebase import extensions
waku-org · Sep 13, 2024 · 9d9a696 · 9d9a696
1 parent a2c5dba
commit 9d9a696
Show file tree

Hide file tree

Showing 20 changed files with 72 additions and 58 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -74,7 +74,17 @@
     "@typescript-eslint/await-thenable": "error",
     "@typescript-eslint/no-misused-promises": "error",
     "@typescript-eslint/no-explicit-any": "warn",
-    "id-match": ["error", "^(?!.*[pP]ubSub)"]
+    "id-match": ["error", "^(?!.*[pP]ubSub)"],
+    "import/extensions": [
+      "error",
+      "ignorePackages",
+      {
+        "js": "never",
+        "jsx": "never",
+        "ts": "always",
+        "tsx": "never"
+      }
+    ]
   },
   "overrides": [
     {

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/interfaces/src/connection_manager.ts b/packages/interfaces/src/connection_manager.ts
@@ -1,6 +1,6 @@
 import type { Peer, PeerId, TypedEventEmitter } from "@libp2p/interface";
 
-import { PubsubTopic } from "./misc";
+import { PubsubTopic } from "./misc.js";
 
 export enum Tags {
   BOOTSTRAP = "bootstrap",

diff --git a/packages/interfaces/src/enr.ts b/packages/interfaces/src/enr.ts
@@ -2,7 +2,7 @@ import type { PeerId } from "@libp2p/interface";
 import type { PeerInfo } from "@libp2p/interface";
 import type { Multiaddr } from "@multiformats/multiaddr";
 
-import { ShardInfo } from "./sharding";
+import { ShardInfo } from "./sharding.js";
 
 export type ENRKey = string;
 export type ENRValue = Uint8Array;

diff --git a/packages/interfaces/src/health_manager.ts b/packages/interfaces/src/health_manager.ts
@@ -1,4 +1,4 @@
-import { Protocols } from "./protocols";
+import { Protocols } from "./protocols.js";
 
 export enum HealthStatus {
   Unhealthy = "Unhealthy",

diff --git a/packages/interfaces/src/libp2p.ts b/packages/interfaces/src/libp2p.ts
@@ -4,7 +4,7 @@ import type { Libp2p as BaseLibp2p } from "@libp2p/interface";
 import type { PingService } from "@libp2p/ping";
 import type { Libp2pInit, Libp2pOptions } from "libp2p";
 
-import { IMetadata } from "./metadata";
+import { IMetadata } from "./metadata.js";
 
 export type Libp2pServices = {
   ping: PingService;

diff --git a/packages/tests/src/lib/index.ts b/packages/tests/src/lib/index.ts
@@ -3,8 +3,8 @@ import { NetworkConfig } from "@waku/interfaces";
 import { derivePubsubTopicsFromNetworkConfig, Logger } from "@waku/utils";
 import { expect } from "chai";
 
-import { DefaultTestPubsubTopic } from "../constants";
-import { Args, MessageRpcQuery, MessageRpcResponse } from "../types";
+import { DefaultTestPubsubTopic } from "../constants.js";
+import { Args, MessageRpcQuery, MessageRpcResponse } from "../types.js";
 import { delay, makeLogFileName } from "../utils/index.js";
 
 import { MessageCollector } from "./message_collector.js";

diff --git a/packages/tests/src/sync-rln-tree.js b/packages/tests/src/sync-rln-tree.js
@@ -2,8 +2,8 @@ import { exec } from "child_process";
 import { setTimeout } from "timers";
 import { promisify } from "util";
 
-import { SEPOLIA_RPC_URL } from "../dist/constants.js";
-import { ServiceNode } from "../dist/lib/service_node.js";
+import { SEPOLIA_RPC_URL } from "./constants.js";
+import { ServiceNode } from "./lib/index.js";
 
 const execAsync = promisify(exec);
 

diff --git a/packages/tests/src/utils/custom_mocha_hooks.ts b/packages/tests/src/utils/custom_mocha_hooks.ts
@@ -1,7 +1,7 @@
 import { Logger } from "@waku/utils";
 import { Suite } from "mocha";
 
-import { MOCHA_HOOK_MAX_TIMEOUT } from "../constants";
+import { MOCHA_HOOK_MAX_TIMEOUT } from "../constants.js";
 const log = new Logger("test:mocha-hook");
 
 function withGracefulTimeout(

diff --git a/packages/tests/src/utils/nodes.ts b/packages/tests/src/utils/nodes.ts
@@ -12,11 +12,11 @@ import { derivePubsubTopicsFromNetworkConfig, isDefined } from "@waku/utils";
 import { Context } from "mocha";
 import pRetry from "p-retry";
 
-import { NOISE_KEY_1 } from "../constants";
-import { ServiceNodesFleet } from "../lib";
-import { Args } from "../types";
+import { NOISE_KEY_1 } from "../constants.js";
+import { ServiceNodesFleet } from "../lib/index.js";
+import { Args } from "../types.js";
 
-import { waitForConnections } from "./waitForConnections";
+import { waitForConnections } from "./waitForConnections.js";
 
 export async function runMultipleNodes(
   context: Context,

diff --git a/packages/tests/src/utils/waku_versions_utils.ts b/packages/tests/src/utils/waku_versions_utils.ts
@@ -1,4 +1,4 @@
-import { DOCKER_IMAGE_NAME } from "../lib/service_node";
+import { DOCKER_IMAGE_NAME } from "../lib/service_node.js";
 
 // Utility to add test conditions based on nwaku/go-waku versions
 export function isNwakuAtLeast(requiredVersion: string): boolean {

diff --git a/packages/tests/tests/filter/ping.node.spec.ts b/packages/tests/tests/filter/ping.node.spec.ts
@@ -16,7 +16,7 @@ import {
   TestEncoder,
   TestShardInfo,
   validatePingError
-} from "./utils";
+} from "./utils.js";
 
 const runTests = (strictCheckNodes: boolean): void => {
   describe(`Waku Filter V2: Ping: Multiple Nodes: Strict Checking: ${strictCheckNodes}`, function () {

diff --git a/packages/tests/tests/filter/single_node/push.node.spec.ts b/packages/tests/tests/filter/single_node/push.node.spec.ts
@@ -13,7 +13,7 @@ import {
   TEST_STRING,
   TEST_TIMESTAMPS
 } from "../../../src/index.js";
-import { runNodes } from "../../light-push/utils";
+import { runNodes } from "../../light-push/utils.js";
 import {
   messageText,
   TestContentTopic,

diff --git a/packages/tests/tests/filter/single_node/unsubscribe.node.spec.ts b/packages/tests/tests/filter/single_node/unsubscribe.node.spec.ts
@@ -11,7 +11,7 @@ import {
   ServiceNode,
   tearDownNodes
 } from "../../../src/index.js";
-import { runNodes } from "../../light-push/utils";
+import { runNodes } from "../../light-push/utils.js";
 import {
   messagePayload,
   messageText,

diff --git a/packages/tests/tests/filter/utils.ts b/packages/tests/tests/filter/utils.ts
@@ -18,7 +18,11 @@ import { utf8ToBytes } from "@waku/utils/bytes";
 import { Context } from "mocha";
 import pRetry from "p-retry";
 
-import { NOISE_KEY_1, ServiceNodesFleet, waitForConnections } from "../../src";
+import {
+  NOISE_KEY_1,
+  ServiceNodesFleet,
+  waitForConnections
+} from "../../src/index.js";
 
 // Constants for test configuration.
 export const log = new Logger("test:filter");

diff --git a/packages/tests/tests/health-manager/node.spec.ts b/packages/tests/tests/health-manager/node.spec.ts
@@ -8,14 +8,14 @@ import {
   runMultipleNodes,
   ServiceNode,
   ServiceNodesFleet
-} from "../../src";
+} from "../../src/index.js";
 
 import {
   messagePayload,
   TestDecoder,
   TestEncoder,
   TestShardInfo
-} from "./utils";
+} from "./utils.js";
 
 describe("Node Health Status Matrix Tests", function () {
   let waku: LightNode;

diff --git a/packages/tests/tests/light-push/index.node.spec.ts b/packages/tests/tests/light-push/index.node.spec.ts
@@ -11,7 +11,7 @@ import {
   ServiceNodesFleet,
   teardownNodesWithRedundancy,
   TEST_STRING
-} from "../../src";
+} from "../../src/index.js";
 
 import {
   messagePayload,

diff --git a/packages/tests/tests/peer-exchange/pe.optional.spec.ts b/packages/tests/tests/peer-exchange/pe.optional.spec.ts
@@ -12,7 +12,7 @@ import {
 } from "@waku/utils";
 import { expect } from "chai";
 
-import { afterEachCustom, tearDownNodes } from "../../src";
+import { afterEachCustom, tearDownNodes } from "../../src/index.js";
 
 describe("Peer Exchange", () => {
   describe("Auto Discovery", function () {

diff --git a/packages/tests/tests/store/utils.ts b/packages/tests/tests/store/utils.ts
@@ -16,7 +16,7 @@ import { Logger, singleShardInfoToPubsubTopic } from "@waku/utils";
 import { expect } from "chai";
 import { Context } from "mocha";
 
-import { delay, NOISE_KEY_1, runNodes, ServiceNode } from "../../src";
+import { delay, NOISE_KEY_1, runNodes, ServiceNode } from "../../src/index.js";
 
 export const log = new Logger("test:store");
 

diff --git a/packages/utils/src/common/sharding/index.spec.ts b/packages/utils/src/common/sharding/index.spec.ts
@@ -13,7 +13,7 @@ import {
   shardInfoToPubsubTopics,
   singleShardInfosToShardInfo,
   singleShardInfoToPubsubTopic
-} from ".";
+} from "./index.js";
 
 const testInvalidCases = (
   contentTopics: string[],