Merge pull request #5494 from NomicFoundation/improve-builtin-options

Include the builtin options as part of the global options & augment the types

Author: schaable

v-next/hardhat/src/hre.ts

@@ -4,11 +4,13 @@ import type { HardhatRuntimeEnvironment } from "./types/hre.js";
 import type { UnsafeHardhatRuntimeEnvironmentOptions } from "@ignored/hardhat-vnext-core/types/cli";
 
 import {
+  buildGlobalOptionDefinitions,
   // eslint-disable-next-line no-restricted-imports -- This is the one place where we allow it
   createBaseHardhatRuntimeEnvironment,
   resolvePluginList,
 } from "@ignored/hardhat-vnext-core";
 
+import { BUILTIN_GLOBAL_OPTIONS_DEFINITIONS } from "./internal/builtin-global-options.js";
 import { builtinPlugins } from "./internal/builtin-plugins/index.js";
 
 /**
@@ -37,6 +39,18 @@ export async function createHardhatRuntimeEnvironment(
     unsafeOptions.resolvedPlugins = resolvedPlugins;
   }
 
+  if (unsafeOptions.globalOptionDefinitions === undefined) {
+    const pluginGlobalOptionDefinitions = buildGlobalOptionDefinitions(
+      unsafeOptions.resolvedPlugins,
+    );
+    const globalOptionDefinitions = new Map([
+      ...BUILTIN_GLOBAL_OPTIONS_DEFINITIONS,
+      ...pluginGlobalOptionDefinitions,
+    ]);
+
+    unsafeOptions.globalOptionDefinitions = globalOptionDefinitions;
+  }
+
   return createBaseHardhatRuntimeEnvironment(
     config,
     userProvidedGlobalOptions,

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

@@ -0,0 +1,68 @@
+import type { GlobalOptionDefinitions } from "../types/global-options.js";
+
+import { globalOption, ArgumentType } from "../config.js";
+
+export const BUILTIN_GLOBAL_OPTIONS_DEFINITIONS: GlobalOptionDefinitions =
+  new Map([
+    [
+      "config",
+      {
+        pluginId: "builtin",
+        option: globalOption({
+          name: "config",
+          description: "A Hardhat config file.",
+          type: ArgumentType.STRING,
+          defaultValue: "",
+        }),
+      },
+    ],
+    [
+      "help",
+      {
+        pluginId: "builtin",
+        option: globalOption({
+          name: "help",
+          description:
+            "Shows this message, or a task's help if its name is provided.",
+          type: ArgumentType.BOOLEAN,
+          defaultValue: false,
+        }),
+      },
+    ],
+    [
+      "init",
+      {
+        pluginId: "builtin",
+        option: globalOption({
+          name: "init",
+          description: "Initializes a Hardhat project.",
+          type: ArgumentType.BOOLEAN,
+          defaultValue: false,
+        }),
+      },
+    ],
+    [
+      "showStackTraces",
+      {
+        pluginId: "builtin",
+        option: globalOption({
+          name: "showStackTraces",
+          description: "Show stack traces (always enabled on CI servers).",
+          type: ArgumentType.BOOLEAN,
+          defaultValue: false,
+        }),
+      },
+    ],
+    [
+      "version",
+      {
+        pluginId: "builtin",
+        option: globalOption({
+          name: "version",
+          description: "Shows hardhat's version.",
+          type: ArgumentType.BOOLEAN,
+          defaultValue: false,
+        }),
+      },
+    ],
+  ]);

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

@@ -2,8 +2,6 @@ import type { ArgumentType } from "@ignored/hardhat-vnext-core/config";
 import type { GlobalOptionDefinitions } 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;
 
 interface ArgumentDescriptor {
@@ -16,23 +14,10 @@ interface ArgumentDescriptor {
 export function parseGlobalOptions(
   globalOptionDefinitions: GlobalOptionDefinitions,
 ): ArgumentDescriptor[] {
-  const formattedBuiltinOptions = BUILTIN_OPTIONS.map(
-    ({ name, description }) => ({
-      name: formatOptionName(name),
-      description,
-    }),
-  );
-
-  const formattedUserOptions = Array.from(globalOptionDefinitions).map(
-    ([, entry]) => {
-      return {
-        name: formatOptionName(entry.option.name),
-        description: entry.option.description,
-      };
-    },
-  );
-
-  return [...formattedBuiltinOptions, ...formattedUserOptions];
+  return [...globalOptionDefinitions].map(([, { option }]) => ({
+    name: formatOptionName(option.name),
+    description: option.description,
+  }));
 }
 
 export function parseTasks(taskMap: Map<string, Task>): {

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

@@ -28,6 +28,7 @@ import { kebabToCamelCase } from "@ignored/hardhat-vnext-utils/string";
 
 import { resolveHardhatConfigPath } from "../../config.js";
 import { createHardhatRuntimeEnvironment } from "../../hre.js";
+import { BUILTIN_GLOBAL_OPTIONS_DEFINITIONS } from "../builtin-global-options.js";
 import { builtinPlugins } from "../builtin-plugins/index.js";
 import { setGlobalHardhatRuntimeEnvironment } from "../global-hre-instance.js";
 import { importUserConfig } from "../helpers/config-loading.js";
@@ -77,8 +78,12 @@ export async function main(
       builtinGlobalOptions.configPath,
     );
 
-    const globalOptionDefinitions =
+    const pluginGlobalOptionDefinitions =
       buildGlobalOptionDefinitions(resolvedPlugins);
+    const globalOptionDefinitions = new Map([
+      ...BUILTIN_GLOBAL_OPTIONS_DEFINITIONS,
+      ...pluginGlobalOptionDefinitions,
+    ]);
     const userProvidedGlobalOptions = await parseGlobalOptions(
       globalOptionDefinitions,
       cliArguments,
@@ -87,7 +92,7 @@ export async function main(
 
     const hre = await createHardhatRuntimeEnvironment(
       userConfig,
-      userProvidedGlobalOptions,
+      { ...builtinGlobalOptions, ...userProvidedGlobalOptions },
       { resolvedPlugins, globalOptionDefinitions },
     );
 

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

@@ -1,2 +1,14 @@
+import "@ignored/hardhat-vnext-core/types/global-options";
+
+declare module "@ignored/hardhat-vnext-core/types/global-options" {
+  export interface GlobalOptions {
+    config: string;
+    help: boolean;
+    init: boolean;
+    showStackTraces: boolean;
+    version: boolean;
+  }
+}
+
 export type * from "@ignored/hardhat-vnext-core/types/global-options";
 export * from "@ignored/hardhat-vnext-core/types/global-options";

v-next/hardhat/src/types/global-options.ts

@@ -0,0 +1,21 @@
+import type { HardhatUserConfig } from "@ignored/hardhat-vnext/config";
+import type { HardhatPlugin } from "@ignored/hardhat-vnext-core/types/plugins";
+
+import { globalOption } from "@ignored/hardhat-vnext/config";
+
+export const testPlugin: HardhatPlugin = {
+  id: "test-plugin",
+  globalOptions: [
+    globalOption({
+      name: "myGlobalOption",
+      description: "A global option",
+      defaultValue: "default",
+    }),
+  ],
+};
+
+const config: HardhatUserConfig = {
+  plugins: [testPlugin],
+};
+
+export default config;

v-next/hardhat/test/fixture-projects/loaded-config/hardhat.config.js

@@ -132,13 +132,27 @@ describe("HRE", () => {
     describe("programmatic API", () => {
       useFixtureProject("loaded-config");
 
-      it("should load the config file", async () => {
+      it("should load the plugins from the config file", async () => {
         const hre = await import("../../src/index.js");
+        const { testPlugin } = await import(
+          "../fixture-projects/loaded-config/hardhat.config.js"
+        );
+
+        assert.deepEqual(hre.config.plugins, [...builtinPlugins, testPlugin]);
+      });
 
-        assert.deepEqual(hre.config.plugins, [
-          ...builtinPlugins,
-          { id: "test-plugin" },
-        ]);
+      it("should load the global options", async () => {
+        const hre = await import("../../src/index.js");
+
+        assert.deepEqual(hre.globalOptions, {
+          config: "",
+          help: false,
+          init: false,
+          showStackTraces: false,
+          version: false,
+          fooPluginFlag: false,
+          myGlobalOption: "default",
+        });
       });
     });
   });