fix(devkit): add options allow trailing commas for parsing json

nrwl · Jun 1, 2022 · d5af288 · d5af288
1 parent 10e9992
commit d5af288
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 30 deletions.
diff --git a/packages/angular/src/migrations/update-14-2-0/update-tsconfig-target.ts b/packages/angular/src/migrations/update-14-2-0/update-tsconfig-target.ts
@@ -32,17 +32,24 @@ export default async function (tree: Tree) {
   const tsConfigPaths = await collectTsConfigPaths(tree);
 
   for (const tsConfigPath of tsConfigPaths) {
-    updateJson(tree, tsConfigPath, (json) => {
-      if (
-        !json.compilerOptions?.target ||
-        (json.compilerOptions?.target &&
-          !skipTargets.includes(json.compilerOptions.target.toLowerCase()))
-      ) {
-        json.compilerOptions ??= {};
-        json.compilerOptions.target = 'es2020';
+    updateJson(
+      tree,
+      tsConfigPath,
+      (json) => {
+        if (
+          !json.compilerOptions?.target ||
+          (json.compilerOptions?.target &&
+            !skipTargets.includes(json.compilerOptions.target.toLowerCase()))
+        ) {
+          json.compilerOptions ??= {};
+          json.compilerOptions.target = 'es2020';
+        }
+        return json;
+      },
+      {
+        allowTrailingComma: true,
       }
-      return json;
-    });
+    );
   }
 
   await formatFiles(tree);

diff --git a/packages/jest/src/migrations/update-14-0-0/update-jest-config-ext.ts b/packages/jest/src/migrations/update-14-0-0/update-jest-config-ext.ts
@@ -18,12 +18,19 @@ const allowedExt = ['.ts', '.js'];
 
 function updateTsConfig(tree: Tree, tsConfigPath: string) {
   try {
-    updateJson(tree, tsConfigPath, (json) => {
-      json.exclude = Array.from(
-        new Set([...(json.exclude || []), 'jest.config.ts'])
-      );
-      return json;
-    });
+    updateJson(
+      tree,
+      tsConfigPath,
+      (json) => {
+        json.exclude = Array.from(
+          new Set([...(json.exclude || []), 'jest.config.ts'])
+        );
+        return json;
+      },
+      {
+        allowTrailingComma: true,
+      }
+    );
   } catch (e) {
     logger.warn(
       stripIndents`Nx Unable to update ${tsConfigPath}. Please manually ignore the jest.config.ts file.`

diff --git a/packages/nx/src/utils/json.spec.ts b/packages/nx/src/utils/json.spec.ts
@@ -79,4 +79,21 @@ describe('parseJson', () => {
       )
     ).toThrowError();
   });
+
+  it('should handle trailing commas', () => {
+    expect(
+      parseJson(
+        `{
+      "nested": {
+          "test": 123,
+      },
+      "array": [1, 2, 3,]
+  }`,
+        { allowTrailingComma: true }
+      )
+    ).toEqual({
+      nested: { test: 123 },
+      array: [1, 2, 3],
+    });
+  });
 });
diff --git a/packages/nx/src/utils/json.ts b/packages/nx/src/utils/json.ts
@@ -1,9 +1,9 @@
 import { parse, printParseErrorCode, stripComments } from 'jsonc-parser';
-import type { ParseError } from 'jsonc-parser';
+import type { ParseError, ParseOptions } from 'jsonc-parser';
 
 export { stripComments as stripJsonComments };
 
-export interface JsonParseOptions {
+export interface JsonParseOptions extends ParseOptions {
   /**
    * Expect JSON with javascript-style
    * @default false
@@ -14,6 +14,11 @@ export interface JsonParseOptions {
    * @default false
    */
   disallowComments?: boolean;
+
+  /**
+   * Allow trailing commas in the JSON content
+   */
+  allowTrailingComma?: boolean;
 }
 
 export interface JsonSerializeOptions {
@@ -37,20 +42,11 @@ export function parseJson<T extends object = any>(
   options?: JsonParseOptions
 ): T {
   try {
-    if (
-      options?.disallowComments === true ||
-      options?.expectComments !== true
-    ) {
-      return JSON.parse(input);
-    }
-  } catch (error) {
-    if (options?.disallowComments === true) {
-      throw error;
-    }
-  }
+    return JSON.parse(input);
+  } catch {}
 
   const errors: ParseError[] = [];
-  const result: T = parse(input, errors);
+  const result: T = parse(input, errors, options);
 
   if (errors.length > 0) {
     const { error, offset } = errors[0];