Merge pull request #5274 from NomicFoundation/tasks-def

Tasks builders implementation and testing

Author: schaable

v-next/core/src/internal/tasks/builders.ts

@@ -5,3 +5,9 @@ export function formatTaskId(taskId: string | string[]): string {
 
   return taskId.join(" ");
 }
+
+const FILE_PROTOCOL_PATTERN = /^file:\/\/.+/;
+
+export function isValidActionUrl(action: string): boolean {
+  return FILE_PROTOCOL_PATTERN.test(action);
+}

v-next/core/src/internal/tasks/utils.ts

@@ -9,3 +9,59 @@ export enum ParameterType {
   FLOAT = "FLOAT",
   FILE = "FILE",
 }
+
+/**
+ * Maps all the `ParameterType` values to their corresponding value types.
+ */
+export interface ParameterToValueTypeMap {
+  [ParameterType.STRING]: string;
+  [ParameterType.BOOLEAN]: boolean;
+  [ParameterType.INT]: number;
+  [ParameterType.BIGINT]: bigint;
+  [ParameterType.FLOAT]: number;
+  [ParameterType.FILE]: string;
+}
+
+/**
+ * Maps a `ParameterType` to its corresponding value type.
+ *
+ * This type takes a `ParameterType` as a type parameter and returns the type
+ * of the value that should be used for parameters of that type.
+ *
+ * @example
+ * ParameterTypeToValueType<ParameterType.STRING>
+ * // ^? "string"
+ *
+ * @example
+ * ParameterTypeToValueType<ParameterType.INT>
+ * // ^? "number"
+ */
+export type ParameterTypeToValueType<T extends ParameterType> =
+  ParameterToValueTypeMap[T];
+
+const parameterTypeValidators: Record<
+  ParameterType,
+  (value: unknown) => boolean
+> = {
+  [ParameterType.STRING]: (value): value is string => typeof value === "string",
+  [ParameterType.BOOLEAN]: (value): value is boolean =>
+    typeof value === "boolean",
+  [ParameterType.INT]: (value): value is number => Number.isInteger(value),
+  [ParameterType.BIGINT]: (value): value is bigint => typeof value === "bigint",
+  [ParameterType.FLOAT]: (value): value is number => typeof value === "number",
+  [ParameterType.FILE]: (value): value is string => typeof value === "string",
+};
+
+/**
+ * Checks if a parameter value is valid for a given parameter type.
+ *
+ * This function uses a map of validators, where each validator is a function
+ * that checks if a value is valid for a specific parameter type.
+ */
+export function isParameterValueValid(
+  type: ParameterType,
+  value: unknown,
+): boolean {
+  const validator = parameterTypeValidators[type];
+  return validator(value);
+}

v-next/core/src/types/common.ts

@@ -1,5 +1,5 @@
-import { ParameterType } from "./common.js";
-import { HardhatRuntimeEnvironment } from "./hre.js";
+import type { ParameterType, ParameterTypeToValueType } from "./common.js";
+import type { HardhatRuntimeEnvironment } from "./hre.js";
 
 // We add the TaskManager to the HRE with a module augmentation to avoid
 // introducing a circular dependency that would look like this:
@@ -182,11 +182,11 @@ export interface NewTaskDefinitionBuilder {
    * The default value, if provided, should be of the same type as the
    * parameter.
    */
-  addNamedParameter(paramOptions: {
+  addNamedParameter<T extends ParameterType>(paramOptions: {
     name: string;
     description?: string;
-    type?: ParameterType;
-    defaultValue?: any;
+    type?: T;
+    defaultValue?: ParameterTypeToValueType<T>;
   }): this;
 
   /**
@@ -210,11 +210,11 @@ export interface NewTaskDefinitionBuilder {
    * optional, and any other positional parameters after it must also be
    * optional.
    */
-  addPositionalParameter(paramOptions: {
+  addPositionalParameter<T extends ParameterType>(paramOptions: {
     name: string;
     description?: string;
-    type?: ParameterType;
-    defaultValue?: any;
+    type?: T;
+    defaultValue?: ParameterTypeToValueType<T>;
   }): this;
 
   /**
@@ -231,11 +231,11 @@ export interface NewTaskDefinitionBuilder {
    * Note that this parameter must be the last positional parameter. No other
    * positional parameter can follow it, including variadic parameters.
    */
-  addVariadicParameter(paramOptions: {
+  addVariadicParameter<T extends ParameterType>(paramOptions: {
     name: string;
     description?: string;
-    type?: ParameterType;
-    defaultValue?: any[];
+    type?: T;
+    defaultValue?: Array<ParameterTypeToValueType<T>>;
   }): this;
 
   /**
@@ -253,30 +253,30 @@ export interface TaskOverrideDefinitionBuilder {
    */
   setDescription(description: string): this;
 
+  /**
+   * Sets a new action for the task.
+   *
+   * @see NewTaskDefinitionBuilder.setAction
+   */
+  setAction(action: TaskOverrideActionFunction | string): this;
+
   /**
    * Adds a new named parameter to the task.
    *
    * @see NewTaskDefinitionBuilder.addNamedParameter
    */
-  addNamedParameter(paramOptions: {
+  addNamedParameter<T extends ParameterType>(paramOptions: {
     name: string;
     description?: string;
-    type?: ParameterType;
-    defaultValue: any;
+    type?: T;
+    defaultValue?: ParameterTypeToValueType<T>;
   }): this;
 
   /**
    * Adds a named parameter of boolean type and default value false.
    */
   addFlag(paramOptions: { name: string; description?: string }): this;
 
-  /**
-   * Sets a new action for the task.
-   *
-   * @see NewTaskDefinitionBuilder.setAction
-   */
-  setAction(action: TaskOverrideActionFunction | string): this;
-
   /**
    * Builds the TaskOverrideDefinition.
    */