Merge pull request #5370 from NomicFoundation/validate-clashes-pos-param

Add validation for positional parameter clashes with global parameters

Author: schaable

v-next/core/src/internal/tasks/task-manager.ts

@@ -189,20 +189,26 @@ export class TaskManagerImplementation implements TaskManager {
     taskDefinition: NewTaskDefinition | TaskOverrideDefinition,
     pluginId?: string,
   ) {
-    for (const namedParamName of Object.keys(taskDefinition.namedParameters)) {
-      const globalParamEntry = globalParameterIndex.get(namedParamName);
+    const namedParamNames = Object.keys(taskDefinition.namedParameters);
+    const positionalParamNames =
+      "positionalParameters" in taskDefinition
+        ? taskDefinition.positionalParameters.map(({ name }) => name)
+        : [];
+
+    [...namedParamNames, ...positionalParamNames].forEach((paramName) => {
+      const globalParamEntry = globalParameterIndex.get(paramName);
       if (globalParamEntry !== undefined) {
         throw new HardhatError(
           HardhatError.ERRORS.TASK_DEFINITIONS.TASK_PARAMETER_ALREADY_DEFINED,
           {
             actorFragment: getActorFragment(pluginId),
             task: formatTaskId(taskDefinition.id),
-            namedParamName,
+            parameter: paramName,
             globalParamPluginId: globalParamEntry.pluginId,
           },
         );
       }
-    }
+    });
   }
 
   #processTaskOverride(

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

@@ -407,7 +407,45 @@ describe("TaskManagerImplementation", () => {
           {
             actorFragment: "Plugin plugin1 is",
             task: "task1",
-            namedParamName: "param1",
+            parameter: "param1",
+            globalParamPluginId: "plugin2",
+          },
+        ),
+      );
+    });
+
+    it("should throw if there's a global parameter with the same name as a task positional parameter", async () => {
+      await assert.rejects(
+        createHardhatRuntimeEnvironment({
+          plugins: [
+            {
+              id: "plugin1",
+              tasks: [
+                new NewTaskDefinitionBuilderImplementation("task1")
+                  .addPositionalParameter({ name: "param1" })
+                  .setAction(() => {})
+                  .build(),
+              ],
+            },
+            {
+              id: "plugin2",
+              globalParameters: [
+                buildGlobalParameterDefinition({
+                  name: "param1",
+                  description: "",
+                  parameterType: ParameterType.STRING,
+                  defaultValue: "",
+                }),
+              ],
+            },
+          ],
+        }),
+        new HardhatError(
+          HardhatError.ERRORS.TASK_DEFINITIONS.TASK_PARAMETER_ALREADY_DEFINED,
+          {
+            actorFragment: "Plugin plugin1 is",
+            task: "task1",
+            parameter: "param1",
             globalParamPluginId: "plugin2",
           },
         ),

v-next/hardhat-errors/src/descriptors.ts

@@ -247,10 +247,10 @@ Please ensure that an action is defined for each task.`,
     TASK_PARAMETER_ALREADY_DEFINED: {
       number: 209,
       messageTemplate:
-        "{actorFragment} trying to define task {task} with the named parameter {namedParamName} but it is already defined as a global parameter by plugin {globalParamPluginId}",
+        "{actorFragment} trying to define task {task} with the parameter {parameter} but it is already defined as a global parameter by plugin {globalParamPluginId}",
       websiteTitle: "Task parameter already defined",
       websiteDescription:
-        "The task named parameter is already defined as a global parameter by another plugin. Please ensure that task parameters are uniquely named to avoid conflicts.",
+        "The task parameter is already defined as a global parameter by another plugin. Please ensure that task parameters are uniquely named to avoid conflicts.",
     },
     TASK_OVERRIDE_PARAMETER_ALREADY_DEFINED: {
       number: 210,