Use globalOption to create the builtin options

Author: schaable

v-next/example-project/hardhat.config.ts

@@ -6,6 +6,7 @@ import {
   emptyTask,
   overrideTask,
   configVariable,
+  globalOption,
 } from "@ignored/hardhat-vnext/config";
 
 const exampleEmptyTask = emptyTask("empty", "An example empty task").build();
@@ -116,6 +117,13 @@ const pluginExample = {
       })
       .build(),
   ],
+  globalOptions: [
+    globalOption({
+      name: "myGlobalOption",
+      description: "A global option",
+      defaultValue: "default",
+    }),
+  ],
 };
 
 const config: HardhatUserConfig = {

v-next/hardhat/src/internal/builtin-options.ts

@@ -1,21 +1,31 @@
-export const BUILTIN_OPTIONS: Array<{
-  name: string;
-  description: string;
-}> = [
-  {
-    name: "--config",
+import type { GlobalOption } from "../types/global-options.js";
+
+import { globalOption, ParameterType } from "../config.js";
+
+export const BUILTIN_OPTIONS: GlobalOption[] = [
+  globalOption({
+    name: "config",
     description: "A Hardhat config file.",
-  },
-  {
-    name: "--help",
-    description: "Shows this message, or a task's help if its name is provided",
-  },
-  {
-    name: "--show-stack-traces",
+    parameterType: ParameterType.STRING,
+    defaultValue: "",
+  }),
+  globalOption({
+    name: "help",
+    description:
+      "Shows this message, or a task's help if its name is provided.",
+    parameterType: ParameterType.BOOLEAN,
+    defaultValue: false,
+  }),
+  globalOption({
+    name: "showStackTraces",
     description: "Show stack traces (always enabled on CI servers).",
-  },
-  {
-    name: "--version",
+    parameterType: ParameterType.BOOLEAN,
+    defaultValue: false,
+  }),
+  globalOption({
+    name: "version",
     description: "Shows hardhat's version.",
-  },
+    parameterType: ParameterType.BOOLEAN,
+    defaultValue: false,
+  }),
 ];

v-next/hardhat/src/internal/cli/helpers/getGlobalHelpString.ts

@@ -5,6 +5,7 @@ import { getHardhatVersion } from "../../utils/package.js";
 
 import {
   GLOBAL_NAME_PADDING,
+  formatOptionName,
   getLongestNameLength,
   getSection,
   parseTasks,
@@ -17,8 +18,15 @@ export async function getGlobalHelpString(
 
   const { tasks, subtasks } = parseTasks(rootTasks);
 
+  const formattedBuiltinOptions = BUILTIN_OPTIONS.map(
+    ({ name, description }) => ({
+      name: formatOptionName(name),
+      description,
+    }),
+  );
+
   const namePadding =
-    getLongestNameLength([...tasks, ...subtasks, ...BUILTIN_OPTIONS]) +
+    getLongestNameLength([...tasks, ...subtasks, ...formattedBuiltinOptions]) +
     GLOBAL_NAME_PADDING;
 
   let output = `Hardhat version ${version}
@@ -34,7 +42,7 @@ Usage: hardhat [GLOBAL OPTIONS] <TASK> [SUBTASK] [TASK OPTIONS] [--] [TASK ARGUM
     output += getSection("AVAILABLE SUBTASKS", subtasks, namePadding);
   }
 
-  output += getSection("GLOBAL OPTIONS", BUILTIN_OPTIONS, namePadding);
+  output += getSection("GLOBAL OPTIONS", formattedBuiltinOptions, namePadding);
 
   output += `\nTo get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;
 

v-next/hardhat/test/internal/cli/helpers/getGlobalHelpString.ts

@@ -22,7 +22,7 @@ Usage: hardhat [GLOBAL OPTIONS] <TASK> [SUBTASK] [TASK OPTIONS] [--] [TASK ARGUM
 GLOBAL OPTIONS:
 
   --config                 A Hardhat config file.
-  --help                   Shows this message, or a task's help if its name is provided
+  --help                   Shows this message, or a task's help if its name is provided.
   --show-stack-traces      Show stack traces (always enabled on CI servers).
   --version                Shows hardhat's version.
 
@@ -79,7 +79,7 @@ AVAILABLE TASKS:
 GLOBAL OPTIONS:
 
   --config                 A Hardhat config file.
-  --help                   Shows this message, or a task's help if its name is provided
+  --help                   Shows this message, or a task's help if its name is provided.
   --show-stack-traces      Show stack traces (always enabled on CI servers).
   --version                Shows hardhat's version.
 
@@ -150,7 +150,7 @@ AVAILABLE SUBTASKS:
 GLOBAL OPTIONS:
 
   --config                 A Hardhat config file.
-  --help                   Shows this message, or a task's help if its name is provided
+  --help                   Shows this message, or a task's help if its name is provided.
   --show-stack-traces      Show stack traces (always enabled on CI servers).
   --version                Shows hardhat's version.
 

v-next/hardhat/test/internal/cli/main.ts

@@ -222,7 +222,7 @@ AVAILABLE TASKS:
 GLOBAL OPTIONS:
 
   --config                 A Hardhat config file.
-  --help                   Shows this message, or a task's help if its name is provided
+  --help                   Shows this message, or a task's help if its name is provided.
   --show-stack-traces      Show stack traces (always enabled on CI servers).
   --version                Shows hardhat's version.