simplify addition of .js extension

Author: ChristopherDedominici

v-next/hardhat-typechain/src/internal/generate-types.ts

@@ -125,18 +125,13 @@ export function addJsExtensionsIfNeeded(content: string): string {
   // import * from "npmPackage"
   // will not be converted because the import path does not starts with a "."
   const jsExtensionRegex =
-    /^import\s+.*?\s+from\s+(['"])\.[^'"]*(?<!\.js)\1;$/gm;
+    /^import\s+.*?\s+from\s+(['"])\.[^'"]*(?<!\.js)\1;?$/gm;
+
+  return content.replace(jsExtensionRegex, (match) => {
+    const insertIndex = match.includes(";")
+      ? match.length - 2
+      : match.length - 1;
 
-  content = content.replace(jsExtensionRegex, (match) => {
-    const insertIndex = match.lastIndexOf(";") - 1;
     return match.slice(0, insertIndex) + "/index.js" + match.slice(insertIndex);
   });
-
-  // Special scenario for ".d.ts" files: These files lack semicolons at the end,
-  // and imports do not include the ".js" extension.
-  // Handle this separately to improve code readability.
-  // Example:
-  // import { ethers } from 'ethers' // Not modified
-  // import * as Contracts from "." // Modified to: import * as Contracts from "./index.js"
-  return content.replaceAll(`from "."`, `from "./index.js"`);
 }

v-next/hardhat-typechain/test/index.ts

@@ -1,11 +1,67 @@
 import assert from "node:assert/strict";
+import path from "node:path";
 import { before, describe, it } from "node:test";
 
 import { createHardhatRuntimeEnvironment } from "@ignored/hardhat-vnext/hre";
-import { exists, remove } from "@ignored/hardhat-vnext-utils/fs";
+import { exists, readUtf8File, remove } from "@ignored/hardhat-vnext-utils/fs";
 import { useFixtureProject } from "@nomicfoundation/hardhat-test-utils";
 
 describe("hardhat-typechain", () => {
+  describe("check that types are generated correctly", () => {
+    const projectFolder = "generate-types";
+
+    useFixtureProject(projectFolder);
+
+    before(async () => {
+      await remove(`${process.cwd()}/types`);
+    });
+
+    it("should generate the types", async () => {
+      // Check that the types are generated with the expected addition of the "/index.js" extensions
+      // and the v3 modules
+
+      const hardhatConfig = await import(
+        // eslint-disable-next-line import/no-relative-packages -- allow for fixture projects
+        `./fixture-projects/${projectFolder}/hardhat.config.js`
+      );
+
+      const hre = await createHardhatRuntimeEnvironment(hardhatConfig.default);
+
+      assert.equal(await exists(`${process.cwd()}/types`), false);
+
+      await hre.tasks.getTask("clean").run();
+
+      await hre.tasks.getTask("compile").run({});
+
+      const content = await readUtf8File(
+        path.join(process.cwd(), "types", "ethers-contracts", "hardhat.d.ts"),
+      );
+
+      // The overload target the v3 hardhat ethers package
+      assert.equal(
+        content.includes(
+          `declare module "@ignored/hardhat-vnext-ethers/types" {`,
+        ),
+        true,
+      );
+
+      // The import should be from the v3 hardhat ethers package
+      assert.equal(
+        content.includes(`from "@ignored/hardhat-vnext-ethers/types";`),
+        true,
+      );
+
+      // A relative import should have the ".js" extension
+      assert.equal(
+        content.includes(`import * as Contracts from "./index.js"`),
+        true,
+      );
+
+      // The import from a npm package should have ".js" extensions
+      assert.equal(content.includes(`import { ethers } from 'ethers'`), true);
+    });
+  });
+
   describe("generate types from contracts", () => {
     const projectFolder = "generate-types";
 

v-next/hardhat-typechain/test/internal/js-extensions.ts

@@ -31,14 +31,14 @@ import * from "./index.js";`,
 
   it("should correctly add the '/index.js' - simulate .d.ts files", () => {
     const output = addJsExtensionsIfNeeded(`
-import { ethers } from "ethers"; // Not modified
-import * from "." // modified`);
+import { ethers } from "ethers";
+import * from "."`);
 
     assert.equal(
       output,
       `
-import { ethers } from "ethers"; // Not modified
-import * from "./index.js" // modified`,
+import { ethers } from "ethers";
+import * from "./index.js"`,
     );
   });