Merge pull request #7115 from NomicFoundation/change-the-type-of-package-name

Change type of packageName

Author: kanej

.changeset/wicked-lies-reply.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Change the type of the `npmPackage` plugin property ([7058](https://github.com/NomicFoundation/hardhat/issues/7058))

v-next/hardhat/src/internal/core/config-validation.ts

@@ -603,7 +603,8 @@ export function validatePluginsConfig(
 
     if (
       plugin.npmPackage !== undefined &&
-      typeof plugin.npmPackage !== "string"
+      typeof plugin.npmPackage !== "string" &&
+      plugin.npmPackage !== null
     ) {
       validationErrors.push({
         path: [...path, "plugins", index, "npmPackage"],

v-next/hardhat/src/internal/core/plugins/detect-plugin-npm-dependency-problems.ts

@@ -27,13 +27,14 @@ export async function detectPluginNpmDependencyProblems(
   basePathForNpmResolution: string,
   plugin: HardhatPlugin,
 ): Promise<void> {
-  if (plugin.npmPackage === undefined) {
+  if (plugin.npmPackage === null) {
     return;
   }
 
   const pluginPackageJsonPath = await findDependencyPackageJson(
     basePathForNpmResolution,
-    plugin.npmPackage,
+    // When npmPackage is undefined, we use the id as the package name instead
+    plugin.npmPackage ?? plugin.id,
   );
 
   if (pluginPackageJsonPath === undefined) {

v-next/hardhat/src/types/plugins.ts

@@ -32,7 +32,7 @@ export interface HardhatPlugin {
   /**
    * The npm package where the plugin is located, if any.
    */
-  npmPackage?: string;
+  npmPackage?: string | null;
 
   /**
    * An array of plugins that this plugin depends on.

v-next/hardhat/test/internal/core/config-validation.ts

@@ -1432,6 +1432,39 @@ describe("config validation", function () {
   });
 
   describe("validatePluginsConfig", function () {
+    it("should not throw when the npmPackage is a string", function () {
+      const plugins: HardhatPlugin[] = [
+        {
+          id: "plugin-id",
+          npmPackage: "npm-package",
+        },
+      ];
+
+      assert.deepEqual(validatePluginsConfig(plugins, []), []);
+    });
+
+    it("should not throw when the npmPackage is null", function () {
+      const plugins: HardhatPlugin[] = [
+        {
+          id: "plugin-id",
+          npmPackage: null,
+        },
+      ];
+
+      assert.deepEqual(validatePluginsConfig(plugins, []), []);
+    });
+
+    it("should not throw when the npmPackage is undefined", function () {
+      const plugins: HardhatPlugin[] = [
+        {
+          id: "plugin-id",
+          npmPackage: undefined,
+        },
+      ];
+
+      assert.deepEqual(validatePluginsConfig(plugins, []), []);
+    });
+
     it("should return an error if a plugin is not a non-null object", function () {
       const plugins: HardhatPlugin[] = [
         /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- testing validations for js users who can bypass type checks */

v-next/hardhat/test/internal/core/hook-manager.ts

@@ -428,6 +428,7 @@ describe("HookManager", () => {
           hookHandlers: {
             config: import.meta.resolve("./non-existent.js"),
           },
+          npmPackage: null,
         };
 
         const manager = new HookManagerImplementation(projectRoot, [

v-next/hardhat/test/internal/core/plugins/detect-plugin-npm-dependency-problems.ts

@@ -13,14 +13,19 @@ describe("Plugins - detect npm dependency problems", () => {
     npmPackage: "example",
   };
 
+  const pluginWithNpmPackageUndefined: HardhatPlugin = {
+    id: "example",
+    npmPackage: undefined,
+  };
+
   it("should skip validation if the plugin is not from an npm package", async () => {
     const peerDepWithWrongVersionFixture = import.meta.resolve(
       "./fixture-projects/peer-dep-with-wrong-version",
     );
 
     await detectPluginNpmDependencyProblems(peerDepWithWrongVersionFixture, {
       ...plugin,
-      npmPackage: undefined,
+      npmPackage: null,
     });
   });
 
@@ -36,6 +41,17 @@ describe("Plugins - detect npm dependency problems", () => {
       );
     });
 
+    it("should pass validation if the package has been installed and the npmPackage property is undefined but the id matches the installed package", async () => {
+      const installedPackageProjectFixture = import.meta.resolve(
+        "./fixture-projects/installed-package",
+      );
+
+      await detectPluginNpmDependencyProblems(
+        installedPackageProjectFixture,
+        pluginWithNpmPackageUndefined,
+      );
+    });
+
     it("should fail validation if the npm package has not been installed", async () => {
       const nonInstalledPackageProjectFixture = import.meta.resolve(
         "./fixture-projects/not-installed-package",
@@ -53,6 +69,24 @@ describe("Plugins - detect npm dependency problems", () => {
         },
       );
     });
+
+    it("should fail validation if the package has been installed and the npmPackage property is undefined but the id has a value that does not match the installed package", async () => {
+      const nonInstalledPackageProjectFixture = import.meta.resolve(
+        "./fixture-projects/installed-package",
+      );
+
+      await assertRejectsWithHardhatError(
+        async () =>
+          detectPluginNpmDependencyProblems(nonInstalledPackageProjectFixture, {
+            ...pluginWithNpmPackageUndefined,
+            id: "does-not-match-installed-plugin",
+          }),
+        HardhatError.ERRORS.CORE.PLUGINS.PLUGIN_NOT_INSTALLED,
+        {
+          pluginId: "does-not-match-installed-plugin",
+        },
+      );
+    });
   });
 
   describe("when the plugin has peer deps", () => {

v-next/hardhat/test/internal/core/tasks/task-manager.ts

@@ -2096,6 +2096,7 @@ describe("TaskManagerImplementation", () => {
                     .setAction("file://not-a-module")
                     .build(),
                 ],
+                npmPackage: null,
               },
             ],
           },