fix(devkit): respect expectComments when parsing json (#21584)

nrwl · Feb 23, 2024 · de9b6d2 · de9b6d2
1 parent c4cacf1
commit de9b6d2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/packages/nx/src/utils/json.spec.ts b/packages/nx/src/utils/json.spec.ts
@@ -154,4 +154,20 @@ describe('parseJson', () => {
       array: [1, 2, 3],
     });
   });
+
+  it('should not call JSON.parse when expectComments is true', () => {
+    jest.spyOn(JSON, 'parse');
+
+    expect(
+      parseJson(
+        `{
+      /* a comment */
+      "foo": "bar"
+    }`,
+        { expectComments: true }
+      )
+    ).toEqual({ foo: 'bar' });
+
+    expect(JSON.parse).not.toHaveBeenCalled();
+  });
 });
diff --git a/packages/nx/src/utils/json.ts b/packages/nx/src/utils/json.ts
@@ -44,7 +44,9 @@ export function parseJson<T extends object = any>(
   options?: JsonParseOptions
 ): T {
   try {
-    return JSON.parse(input);
+    if (options?.expectComments !== true) {
+      return JSON.parse(input);
+    }
   } catch {}
 
   options = { allowTrailingComma: true, ...options };