fix(devkit): make the JSON parser accepts trailing commas by default (#…

…14317)
nrwl · Jan 12, 2023 · 0d4833c · 0d4833c
1 parent 59de87b
commit 0d4833c
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/docs/generated/devkit/index.md b/docs/generated/devkit/index.md
@@ -1705,7 +1705,7 @@ offsetFromRoot('apps/mydir/myapp/'); // returns "../../../"
 ▸ **parseJson**<`T`\>(`input`, `options?`): `T`
 
 Parses the given JSON string and returns the object the JSON content represents.
-By default javascript-style comments are allowed.
+By default javascript-style comments and trailing commas are allowed.
 
 #### Type parameters
 

diff --git a/docs/generated/packages/devkit/documents/index.md b/docs/generated/packages/devkit/documents/index.md
@@ -1705,7 +1705,7 @@ offsetFromRoot('apps/mydir/myapp/'); // returns "../../../"
 ▸ **parseJson**<`T`\>(`input`, `options?`): `T`
 
 Parses the given JSON string and returns the object the JSON content represents.
-By default javascript-style comments are allowed.
+By default javascript-style comments and trailing commas are allowed.
 
 #### Type parameters
 

diff --git a/packages/nx/src/utils/json.spec.ts b/packages/nx/src/utils/json.spec.ts
@@ -100,7 +100,22 @@ describe('parseJson', () => {
     `);
   });
 
-  it('should throw when JSON has trailing commas', () => {
+  it('should allow trailing commas by default', () => {
+    expect(() =>
+      parseJson(
+        `{
+      "test": 123,
+      "nested": {
+          "test": 123,
+          "more": 456,
+     },
+      "array": [1, 2, 3,]
+  }`
+      )
+    ).not.toThrow();
+  });
+
+  it('should throw when JSON has trailing commas if disabled', () => {
     expect(() =>
       parseJson(
         `{
@@ -111,7 +126,7 @@ describe('parseJson', () => {
      },
       "array": [1, 2, 3,]
   }`,
-        { disallowComments: true, expectComments: true }
+        { allowTrailingComma: false }
       )
     ).toThrowErrorMatchingInlineSnapshot(`
       "PropertyNameExpected in JSON at 6:6

diff --git a/packages/nx/src/utils/json.ts b/packages/nx/src/utils/json.ts
@@ -32,7 +32,7 @@ export interface JsonSerializeOptions {
 
 /**
  * Parses the given JSON string and returns the object the JSON content represents.
- * By default javascript-style comments are allowed.
+ * By default javascript-style comments and trailing commas are allowed.
  *
  * @param input JSON content as string
  * @param options JSON parse options
@@ -46,6 +46,8 @@ export function parseJson<T extends object = any>(
     return JSON.parse(input);
   } catch {}
 
+  options = { allowTrailingComma: true, ...options };
+
   const errors: ParseError[] = [];
   const result: T = parse(input, errors, options);