Merge pull request #800 from erhant/erhant/json5-parser

feat: JSON5 support for module parameters
NomicFoundation · Sep 6, 2024 · bf7e7fb · bf7e7fb
2 parents f3dc8ad + 27f36a8
commit bf7e7fb
Show file tree

Hide file tree

Showing 5 changed files with 836 additions and 817 deletions.
diff --git a/packages/hardhat-plugin/package.json b/packages/hardhat-plugin/package.json
@@ -64,6 +64,7 @@
     "chalk": "^4.0.0",
     "debug": "^4.3.2",
     "fs-extra": "^10.0.0",
-    "prompts": "^2.4.2"
+    "prompts": "^2.4.2",
+    "json5": "^2.2.3"
   }
 }
diff --git a/packages/hardhat-plugin/src/index.ts b/packages/hardhat-plugin/src/index.ts
@@ -15,6 +15,7 @@ import {
 } from "fs-extra";
 import { extendConfig, extendEnvironment, scope } from "hardhat/config";
 import { NomicLabsHardhatPluginError } from "hardhat/plugins";
+import { parse as json5Parse } from "json5";
 import path from "path";
 
 import "./type-extensions";
@@ -241,7 +242,10 @@ ignitionScope
           userModule.id,
           hre.config.paths.ignition
         );
-      } else if (parametersInput.endsWith(".json")) {
+      } else if (
+        parametersInput.endsWith(".json") ||
+        parametersInput.endsWith(".json5")
+      ) {
         parameters = await resolveParametersFromFileName(parametersInput);
       } else {
         parameters = resolveParametersString(parametersInput);
@@ -672,7 +676,7 @@ async function resolveConfigPath(
   try {
     const rawFile = await readFile(filepath);
 
-    return JSON.parse(rawFile.toString(), bigintReviver);
+    return await json5Parse(rawFile.toString(), bigintReviver);
   } catch (e) {
     if (e instanceof NomicLabsHardhatPluginError) {
       throw e;
@@ -692,7 +696,7 @@ async function resolveConfigPath(
 
 function resolveParametersString(paramString: string): DeploymentParameters {
   try {
-    return JSON.parse(paramString, bigintReviver);
+    return json5Parse(paramString, bigintReviver);
   } catch (e) {
     if (e instanceof NomicLabsHardhatPluginError) {
       throw e;

diff --git a/packages/hardhat-plugin/test/fixture-projects/lock/ignition/modules/parameters-json5.json5 b/packages/hardhat-plugin/test/fixture-projects/lock/ignition/modules/parameters-json5.json5
@@ -0,0 +1,16 @@
+/**
+ * comments allowed in json5
+ */
+
+{
+  // no quotes around keys
+  LockModule: {
+    // weird multi-line but should pass
+    unlockTime: "1\
+893\
+499\
+200\
+000n",
+    lockedAmount: "2000000000000n",
+  },
+}
diff --git a/packages/hardhat-plugin/test/module-parameters.ts b/packages/hardhat-plugin/test/module-parameters.ts
@@ -21,6 +21,19 @@ describe("module parameters", () => {
       );
     });
 
+    it("should run if provided with a valid module parameters file in JSON5 format", async function () {
+      await this.hre.run(
+        {
+          scope: "ignition",
+          task: "deploy",
+        },
+        {
+          modulePath: "./ignition/modules/Lock.ts",
+          parameters: "./ignition/modules/parameters-json5.json5",
+        }
+      );
+    });
+
     it("should run if provided with a valid module parameters file encoding a bigint as a string", async function () {
       await this.hre.run(
         {