Add file in hh-core to handle hardhat configuration paths (#5498)

Author: ChristopherDedominici

pnpm-lock.yaml

@@ -15,6 +15,7 @@
   "exports": {
     ".": "./dist/src/index.js",
     "./config": "./dist/src/config.js",
+    "./global-dir": "./dist/src/global-dir.js",
     "./types/arguments": "./dist/src/types/arguments.js",
     "./types/cli": "./dist/src/types/cli.js",
     "./types/config": "./dist/src/types/config.js",
@@ -53,8 +54,8 @@
   ],
   "devDependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
-    "@microsoft/api-extractor": "^7.43.4",
     "@ignored/hardhat-vnext-node-test-reporter": "workspace:^3.0.0-next.2",
+    "@microsoft/api-extractor": "^7.43.4",
     "@types/node": "^20.14.9",
     "@types/semver": "^7.5.8",
     "@typescript-eslint/eslint-plugin": "^7.7.1",
@@ -77,6 +78,7 @@
     "@ignored/hardhat-vnext-errors": "workspace:^3.0.0-next.2",
     "@ignored/hardhat-vnext-utils": "workspace:^3.0.0-next.2",
     "chalk": "^5.3.0",
+    "env-paths": "^2.2.0",
     "semver": "^7.6.2"
   }
 }

v-next/core/package.json

@@ -0,0 +1,17 @@
+import { ensureDir } from "@ignored/hardhat-vnext-utils/fs";
+
+/**
+ *  Returns the path to the hardhat configuration directory.
+ *
+ * @returns The path to the hardhat configuration directory.
+ */
+export async function getConfigDir(): Promise<string> {
+  const { config } = await generatePaths();
+  await ensureDir(config);
+  return config;
+}
+
+async function generatePaths(packageName = "hardhat") {
+  const { default: envPaths } = await import("env-paths");
+  return envPaths(packageName);
+}

v-next/core/src/global-dir.ts

@@ -0,0 +1,15 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+
+import { getConfigDir } from "../src/global-dir.js";
+
+describe("global-dir", () => {
+  describe("getGlobalDir", () => {
+    it("should return the path to the configuration directory with default name 'hardhat'", async () => {
+      const { default: envPaths } = await import("env-paths");
+      const expectedPath = envPaths("hardhat").config;
+
+      assert.equal(await getConfigDir(), expectedPath);
+    });
+  });
+});