Display user-defined global options with --help

Author: schaable

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

@@ -1,32 +1,28 @@
+import type { GlobalOptionsMap } from "@ignored/hardhat-vnext-core/types/global-options";
 import type { Task } from "@ignored/hardhat-vnext-core/types/tasks";
 
-import { BUILTIN_OPTIONS } from "../../builtin-options.js";
 import { getHardhatVersion } from "../../utils/package.js";
 
 import {
   GLOBAL_NAME_PADDING,
-  formatOptionName,
   getLongestNameLength,
   getSection,
+  parseGlobalOptions,
   parseTasks,
 } from "./utils.js";
 
 export async function getGlobalHelpString(
   rootTasks: Map<string, Task>,
+  globalOptionsMap: GlobalOptionsMap,
 ): Promise<string> {
   const version = await getHardhatVersion();
 
   const { tasks, subtasks } = parseTasks(rootTasks);
 
-  const formattedBuiltinOptions = BUILTIN_OPTIONS.map(
-    ({ name, description }) => ({
-      name: formatOptionName(name),
-      description,
-    }),
-  );
+  const globalOptions = parseGlobalOptions(globalOptionsMap);
 
   const namePadding =
-    getLongestNameLength([...tasks, ...subtasks, ...formattedBuiltinOptions]) +
+    getLongestNameLength([...tasks, ...subtasks, ...globalOptions]) +
     GLOBAL_NAME_PADDING;
 
   let output = `Hardhat version ${version}
@@ -42,7 +38,7 @@ Usage: hardhat [GLOBAL OPTIONS] <TASK> [SUBTASK] [TASK OPTIONS] [--] [TASK ARGUM
     output += getSection("AVAILABLE SUBTASKS", subtasks, namePadding);
   }
 
-  output += getSection("GLOBAL OPTIONS", formattedBuiltinOptions, namePadding);
+  output += getSection("GLOBAL OPTIONS", globalOptions, namePadding);
 
   output += `\nTo get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;
 

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

@@ -1,8 +1,31 @@
 import type { ParameterType } from "@ignored/hardhat-vnext-core/config";
+import type { GlobalOptionsMap } from "@ignored/hardhat-vnext-core/types/global-options";
 import type { Task } from "@ignored/hardhat-vnext-core/types/tasks";
 
+import { BUILTIN_OPTIONS } from "../../builtin-options.js";
+
 export const GLOBAL_NAME_PADDING = 6;
 
+export function parseGlobalOptions(
+  globalOptionsMap: GlobalOptionsMap,
+): Array<{ name: string; description: string }> {
+  const formattedBuiltinOptions = BUILTIN_OPTIONS.map(
+    ({ name, description }) => ({
+      name: formatOptionName(name),
+      description,
+    }),
+  );
+
+  const formattedUserOptions = Array.from(globalOptionsMap).map(([, entry]) => {
+    return {
+      name: formatOptionName(entry.option.name),
+      description: entry.option.description,
+    };
+  });
+
+  return [...formattedBuiltinOptions, ...formattedUserOptions];
+}
+
 export function parseTasks(taskMap: Map<string, Task>): {
   tasks: Array<{ name: string; description: string }>;
   subtasks: Array<{ name: string; description: string }>;

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

@@ -96,7 +96,10 @@ export async function main(
 
     if (Array.isArray(taskOrId)) {
       if (taskOrId.length === 0) {
-        const globalHelp = await getGlobalHelpString(hre.tasks.rootTasks);
+        const globalHelp = await getGlobalHelpString(
+          hre.tasks.rootTasks,
+          globalOptionsMap,
+        );
 
         print(globalHelp);
         return;

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

@@ -3,6 +3,11 @@ import type { Task } from "@ignored/hardhat-vnext-core/types/tasks";
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 
+import { buildGlobalOptionsMap } from "@ignored/hardhat-vnext-core";
+import {
+  globalOption,
+  ParameterType,
+} from "@ignored/hardhat-vnext-core/config";
 import { readClosestPackageJson } from "@ignored/hardhat-vnext-utils/package";
 
 import { getGlobalHelpString } from "../../../../src/internal/cli/helpers/getGlobalHelpString.js";
@@ -13,7 +18,7 @@ describe("getGlobalHelpString", async function () {
   describe("when there are no tasks", function () {
     it("should return the global help string", async function () {
       const tasks = new Map();
-      const help = await getGlobalHelpString(tasks);
+      const help = await getGlobalHelpString(tasks, new Map());
 
       const expected = `Hardhat version ${packageJson.version}
 
@@ -65,7 +70,7 @@ To get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;
         ],
       ]);
 
-      const help = await getGlobalHelpString(tasks);
+      const help = await getGlobalHelpString(tasks, new Map());
 
       const expected = `Hardhat version ${packageJson.version}
 
@@ -132,7 +137,7 @@ To get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;
         ],
       ]);
 
-      const help = await getGlobalHelpString(tasks);
+      const help = await getGlobalHelpString(tasks, new Map());
 
       const expected = `Hardhat version ${packageJson.version}
 
@@ -154,6 +159,49 @@ GLOBAL OPTIONS:
   --show-stack-traces      Show stack traces (always enabled on CI servers).
   --version                Shows hardhat's version.
 
+To get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;
+
+      assert.equal(help, expected);
+    });
+  });
+
+  describe("when there are user-defined global options", function () {
+    it("should return the global help string with the user-defined global options", async function () {
+      const tasks = new Map();
+      const globalOptionsMap = buildGlobalOptionsMap([
+        {
+          id: "plugin1",
+          globalOptions: [
+            globalOption({
+              name: "userOption1",
+              description: "userOption1 description.",
+              parameterType: ParameterType.STRING,
+              defaultValue: "default",
+            }),
+            globalOption({
+              name: "userOption2",
+              description: "userOption2 description.",
+              parameterType: ParameterType.STRING,
+              defaultValue: "default",
+            }),
+          ],
+        },
+      ]);
+      const help = await getGlobalHelpString(tasks, globalOptionsMap);
+
+      const expected = `Hardhat version ${packageJson.version}
+
+Usage: hardhat [GLOBAL OPTIONS] <TASK> [SUBTASK] [TASK OPTIONS] [--] [TASK ARGUMENTS]
+
+GLOBAL OPTIONS:
+
+  --config                 A Hardhat config file.
+  --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.
+  --user-option-1          userOption1 description.
+  --user-option-2          userOption2 description.
+
 To get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;
 
       assert.equal(help, expected);

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

@@ -225,6 +225,7 @@ GLOBAL OPTIONS:
   --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.
+  --flag                   A flag
 
 To get help for a specific task run: npx hardhat <TASK> [SUBTASK] --help`;