export resolveHardhatConfigPath in public API

Author: zoeyTM

v-next/hardhat/src/config.ts

@@ -1,2 +1,20 @@
+import { findClosestHardhatConfig } from "./internal/helpers/config-loading.js";
+
 export type * from "@nomicfoundation/hardhat-core/config";
 export * from "@nomicfoundation/hardhat-core/config";
+
+/**
+ * Attempts to find the nearest Hardhat config file, starting from the current
+ * working directory. If no config file is found, an error is thrown.
+ *
+ * @returns The path to the nearest Hardhat config file.
+ */
+export async function resolveHardhatConfigPath(): Promise<string> {
+  const configPath = process.env.HARDHAT_CONFIG;
+
+  if (configPath !== undefined) {
+    return configPath;
+  }
+
+  return findClosestHardhatConfig();
+}

v-next/hardhat/src/index.ts

@@ -1,10 +1,8 @@
-import {
-  importUserConfig,
-  resolveConfigPath,
-} from "./internal/helpers/config-loading.js";
+import { resolveHardhatConfigPath } from "./config.js";
+import { importUserConfig } from "./internal/helpers/config-loading.js";
 import { getHardhatRuntimeEnvironmentSingleton } from "./internal/hre-singleton.js";
 
-const configPath = await resolveConfigPath();
+const configPath = await resolveHardhatConfigPath();
 const userConfig = await importUserConfig(configPath);
 
 const hre = await getHardhatRuntimeEnvironmentSingleton(userConfig);

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

@@ -26,11 +26,9 @@ import {
 import { isCi } from "@nomicfoundation/hardhat-utils/ci";
 import { kebabToCamelCase } from "@nomicfoundation/hardhat-utils/string";
 
+import { resolveHardhatConfigPath } from "../../config.js";
 import { builtinPlugins } from "../builtin-plugins/index.js";
-import {
-  importUserConfig,
-  resolveConfigPath,
-} from "../helpers/config-loading.js";
+import { importUserConfig } from "../helpers/config-loading.js";
 import { getHardhatRuntimeEnvironmentSingleton } from "../hre-singleton.js";
 
 import { getGlobalHelpString } from "./helpers/getGlobalHelpString.js";
@@ -55,7 +53,7 @@ export async function main(cliArguments: string[], print = console.log) {
   }
 
   if (hardhatSpecialArgs.configPath === undefined) {
-    hardhatSpecialArgs.configPath = await resolveConfigPath();
+    hardhatSpecialArgs.configPath = await resolveHardhatConfigPath();
   }
 
   try {

v-next/hardhat/src/internal/helpers/config-loading.ts

@@ -5,7 +5,7 @@ import { HardhatError } from "@nomicfoundation/hardhat-errors";
 import { findUp } from "@nomicfoundation/hardhat-utils/fs";
 import { isObject } from "@nomicfoundation/hardhat-utils/lang";
 
-async function findClosestHardhatConfig(): Promise<string> {
+export async function findClosestHardhatConfig(): Promise<string> {
   let hardhatConfigPath = await findUp("hardhat.config.ts");
 
   if (hardhatConfigPath !== undefined) {
@@ -21,16 +21,6 @@ async function findClosestHardhatConfig(): Promise<string> {
   throw new HardhatError(HardhatError.ERRORS.GENERAL.NO_CONFIG_FILE_FOUND);
 }
 
-export async function resolveConfigPath(): Promise<string> {
-  const configPath = process.env.HARDHAT_CONFIG;
-
-  if (configPath !== undefined) {
-    return configPath;
-  }
-
-  return findClosestHardhatConfig();
-}
-
 export async function importUserConfig(configPath: string) {
   const normalizedPath = isAbsolute(configPath)
     ? configPath

v-next/hardhat/test/src/hre/index.ts

@@ -1,9 +1,9 @@
 import assert from "node:assert/strict";
 import { describe, it } from "node:test";
 
+import { resolveHardhatConfigPath } from "../../../src/config.js";
 import { createHardhatRuntimeEnvironment } from "../../../src/hre.js";
 import { builtinPlugins } from "../../../src/internal/builtin-plugins/index.js";
-import { resolveConfigPath } from "../../../src/internal/helpers/config-loading.js";
 import {
   getHardhatRuntimeEnvironmentSingleton,
   resetHardhatRuntimeEnvironmentSingleton,
@@ -47,13 +47,13 @@ describe("HRE", () => {
       it("should return the HARDHAT_CONFIG env variable if it is set", async () => {
         process.env.HARDHAT_CONFIG = "env.config.js";
 
-        assert.equal(await resolveConfigPath(), "env.config.js");
+        assert.equal(await resolveHardhatConfigPath(), "env.config.js");
 
         delete process.env.HARDHAT_CONFIG;
       });
 
       it("should throw if the config file is not found", async () => {
-        await assert.rejects(resolveConfigPath(), {
+        await assert.rejects(resolveHardhatConfigPath(), {
           message: "HHE5: No Hardhat config file found",
         });
       });
@@ -63,7 +63,7 @@ describe("HRE", () => {
           useFixtureProject("config-js");
 
           it("should load a config file in the current directory", async () => {
-            const configPath = await resolveConfigPath();
+            const configPath = await resolveHardhatConfigPath();
 
             assert(
               configPath.endsWith("hardhat.config.js"),
@@ -76,7 +76,7 @@ describe("HRE", () => {
           useFixtureProject("config-js", "nested-folder");
 
           it("should load a config file in the parent directory", async () => {
-            const configPath = await resolveConfigPath();
+            const configPath = await resolveHardhatConfigPath();
 
             assert(
               configPath.endsWith("hardhat.config.js"),
@@ -91,7 +91,7 @@ describe("HRE", () => {
           useFixtureProject("config-ts");
 
           it("should load a config file in the current directory", async () => {
-            const configPath = await resolveConfigPath();
+            const configPath = await resolveHardhatConfigPath();
 
             assert(
               configPath.endsWith("hardhat.config.ts"),
@@ -104,7 +104,7 @@ describe("HRE", () => {
           useFixtureProject("config-ts", "nested-folder");
 
           it("should load a config file in the parent directory", async () => {
-            const configPath = await resolveConfigPath();
+            const configPath = await resolveHardhatConfigPath();
 
             assert(
               configPath.endsWith("hardhat.config.ts"),

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

@@ -231,6 +231,7 @@ Usage: hardhat [GLOBAL OPTIONS] <TASK> [SUBTASK] [TASK OPTIONS] [--] [TASK ARGUM
 AVAILABLE TASKS:
 
   example                  Example task
+  run                      Runs a user-defined script after compiling the project
   task                     A task that uses param1
 
 GLOBAL OPTIONS: