Inline task actions - strong types check

.changeset/smooth-socks-dance.md

@@ -0,0 +1,7 @@
+---
+"@nomicfoundation/hardhat-errors": patch
+"@nomicfoundation/hardhat-verify": patch
+"hardhat": patch
+---
+
+Added support for `inline actions` in tasks [7851](https://github.com/NomicFoundation/hardhat/pull/7851).

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

@@ -694,6 +694,22 @@ Please double check your arguments.`,
 
 Please check you have the correct subtask.`,
       },
+      INLINE_ACTION_CANNOT_BE_USED_IN_PLUGINS: {
+        number: 417,
+        messageTemplate: `The task "{task}" defines an "inlineAction", which is not allowed in plugins.`,
+        websiteTitle: "Inline action not allowed in plugins",
+        websiteDescription: `Plugins are not allowed to use inline actions for tasks.
+
+Please define the action in a separate file and reference it.`,
+      },
+      ACTION_AND_INLINE_ACTION_CONFLICT: {
+        number: 418,
+        messageTemplate: `The definition for task "{task}" contains conflicting properties: "action" and "inlineAction". You must remove one of them.`,
+        websiteTitle: `Task definition cannot use both "action" and "inlineAction"`,
+        websiteDescription: `A task cannot define both "action" and "inlineAction" properties at the same time.
+
+Please remove one of the properties.`,
+      },
     },
     ARGUMENTS: {
       INVALID_VALUE_FOR_TYPE: {

v-next/hardhat-verify/src/internal/tasks/verify/blockscout/index.ts

@@ -1,13 +1,14 @@
-import type { NewTaskDefinition } from "hardhat/types/tasks";
+import type { PluginSafeTaskDefinition } from "hardhat/types/plugins";
 
 import { task } from "hardhat/config";
 
 import { extendWithVerificationArgs } from "../utils.js";
 
-const verifyBlockscoutTask: NewTaskDefinition = extendWithVerificationArgs(
-  task(["verify", "blockscout"], "Verify a contract on Blockscout"),
-)
-  .setAction(() => import("./task-action.js"))
-  .build();
+const verifyBlockscoutTask: PluginSafeTaskDefinition =
+  extendWithVerificationArgs(
+    task(["verify", "blockscout"], "Verify a contract on Blockscout"),
+  )
+    .setAction(() => import("./task-action.js"))
+    .build();
 
 export default verifyBlockscoutTask;

v-next/hardhat-verify/src/internal/tasks/verify/etherscan/index.ts

@@ -1,13 +1,14 @@
-import type { NewTaskDefinition } from "hardhat/types/tasks";
+import type { PluginSafeTaskDefinition } from "hardhat/types/plugins";
 
 import { task } from "hardhat/config";
 
 import { extendWithVerificationArgs } from "../utils.js";
 
-const verifyEtherscanTask: NewTaskDefinition = extendWithVerificationArgs(
-  task(["verify", "etherscan"], "Verify a contract on Etherscan"),
-)
-  .setAction(() => import("./task-action.js"))
-  .build();
+const verifyEtherscanTask: PluginSafeTaskDefinition =
+  extendWithVerificationArgs(
+    task(["verify", "etherscan"], "Verify a contract on Etherscan"),
+  )
+    .setAction(() => import("./task-action.js"))
+    .build();
 
 export default verifyEtherscanTask;

v-next/hardhat-verify/src/internal/tasks/verify/index.ts

@@ -1,10 +1,10 @@
-import type { NewTaskDefinition } from "hardhat/types/tasks";
+import type { PluginSafeTaskDefinition } from "hardhat/types/plugins";
 
 import { task } from "hardhat/config";
 
 import { extendWithSourcifyArgs, extendWithVerificationArgs } from "./utils.js";
 
-const verifyTask: NewTaskDefinition = extendWithSourcifyArgs(
+const verifyTask: PluginSafeTaskDefinition = extendWithSourcifyArgs(
   extendWithVerificationArgs(
     task("verify", "Verify a contract on all supported explorers"),
   ),

v-next/hardhat-verify/src/internal/tasks/verify/sourcify/index.ts

@@ -1,4 +1,4 @@
-import type { NewTaskDefinition } from "hardhat/types/tasks";
+import type { PluginSafeTaskDefinition } from "hardhat/types/plugins";
 
 import { task } from "hardhat/config";
 
@@ -7,7 +7,7 @@ import {
   extendWithVerificationArgs,
 } from "../utils.js";
 
-const verifySourcifyTask: NewTaskDefinition = extendWithSourcifyArgs(
+const verifySourcifyTask: PluginSafeTaskDefinition = extendWithSourcifyArgs(
   extendWithVerificationArgs(
     task(["verify", "sourcify"], "Verify a contract on Sourcify"),
   ),

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

@@ -18,9 +18,9 @@ import {
 } from "../../types/arguments.js";
 import {
   type EmptyTaskDefinition,
+  TaskDefinitionType,
   type NewTaskDefinition,
   type TaskDefinition,
-  TaskDefinitionType,
   type TaskOverrideDefinition,
 } from "../../types/tasks.js";
 
@@ -272,12 +272,23 @@ export function validateNewTask(
     });
   }
 
-  if (typeof task.action !== "function") {
-    validationErrors.push({
-      path: [...path, "action"],
-      message:
-        "task action must be a lazy import function returning a module with a default export",
-    });
+  // Either action or inlineAction must be defined
+  if (task.action !== undefined) {
+    if (typeof task.action !== "function") {
+      validationErrors.push({
+        path: [...path, "action"],
+        message:
+          "task action must be a lazy import function returning a module with a default export",
+      });
+    }
+  } else {
+    if (typeof task.inlineAction !== "function") {
+      validationErrors.push({
+        path: [...path, "inlineAction"],
+        message:
+          "task inlineAction must be a function implementing the task's behavior",
+      });
+    }
   }
 
   if (isObject(task.options)) {
@@ -328,12 +339,23 @@ export function validateTaskOverride(
     });
   }
 
-  if (typeof task.action !== "function") {
-    validationErrors.push({
-      path: [...path, "action"],
-      message:
-        "task action must be a lazy import function returning a module with a default export",
-    });
+  // Either action or inlineAction must be defined
+  if (task.action !== undefined) {
+    if (typeof task.action !== "function") {
+      validationErrors.push({
+        path: [...path, "action"],
+        message:
+          "task action must be a lazy import function returning a module with a default export",
+      });
+    }
+  } else {
+    if (typeof task.inlineAction !== "function") {
+      validationErrors.push({
+        path: [...path, "inlineAction"],
+        message:
+          "task inlineAction must be a function implementing the task's behavior",
+      });
+    }
   }
 
   if (isObject(task.options)) {