refactor(@angular-devkit/core): remove deprecated parseJson and ParseJsonOptions APIs

BREAKING CHANGE:

`parseJson` and `ParseJsonOptions` APIs have been removed in favor of 3rd party JSON parsers such as `jsonc-parser`.

Author: alan-agius4

packages/angular_devkit/core/src/json/parser.ts

@@ -23,7 +23,7 @@ import {
   JsonAstString,
   Position,
 } from './parser_ast';
-import { JsonArray, JsonObject, JsonValue } from './utils';
+import { JsonArray, JsonObject } from './utils';
 
 export class JsonException extends BaseException {}
 
@@ -61,16 +61,6 @@ export class UnexpectedEndOfInputException extends JsonException {
   }
 }
 
-/**
- * An error happened within a file.
- * @deprecated Deprecated since version 11. Use 3rd party JSON parsers such as `jsonc-parser` instead.
- */
-export class PathSpecificJsonException extends JsonException {
-  constructor(public path: string, public exception: JsonException) {
-    super(`An error happened at file path ${JSON.stringify(path)}: ${exception.message}`);
-  }
-}
-
 /**
  * Context passed around the parser with information about where we currently are in the parse.
  * @deprecated Deprecated since version 11. Use 3rd party JSON parsers such as `jsonc-parser` instead.
@@ -904,51 +894,3 @@ export function parseJsonAst(input: string, mode = JsonParseMode.Default): JsonA
 
   return ast;
 }
-
-/**
- * Options for the parseJson() function.
- * @deprecated Deprecated since version 11. Use 3rd party JSON parsers such as `jsonc-parser` instead.
- */
-export interface ParseJsonOptions {
-  /**
-   * If omitted, will only emit errors related to the content of the JSON. If specified, any
-   * JSON errors will also include the path of the file that caused the error.
-   */
-  path?: string;
-}
-
-/**
- * Parse a JSON string into its value.  This discards the AST and only returns the value itself.
- *
- * If a path option is pass, it also absorbs JSON parsing errors and return a new error with the
- * path in it. Useful for showing errors when parsing from a file.
- *
- * @deprecated Deprecated since version 11. Use 3rd party JSON parsers such as `jsonc-parser` instead.
- * @param input The string to parse.
- * @param mode The mode to parse the input with. {@see JsonParseMode}.
- * @param options Additional optinos for parsing.
- * @returns {JsonValue} The value represented by the JSON string.
- */
-export function parseJson(
-  input: string,
-  mode = JsonParseMode.Default,
-  options?: ParseJsonOptions,
-): JsonValue {
-  try {
-    // Try parsing for the fastest path available, if error, uses our own parser for better errors.
-    if (mode == JsonParseMode.Strict) {
-      try {
-        return JSON.parse(input);
-      } catch (err) {
-        return parseJsonAst(input, mode).value;
-      }
-    }
-
-    return parseJsonAst(input, mode).value;
-  } catch (e) {
-    if (options && options.path && e instanceof JsonException) {
-      throw new PathSpecificJsonException(options.path, e);
-    }
-    throw e;
-  }
-}

packages/angular_devkit/core/src/json/parser_spec.ts

@@ -6,15 +6,15 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { JsonParseMode, parseJson, parseJsonAst } from './parser';
+import { JsonParseMode, parseJsonAst } from './parser';
 
 // Node 6 compatibility.
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function entries(x: { [key: string]: any }): any {
   return Object.keys(x).map((k) => [k, x[k]]);
 }
 
-describe('parseJson and parseJsonAst', () => {
+describe('parseJsonAst', () => {
   describe('generic', () => {
     const numbers = {};
     const errors = ['', '-abcdefghijklmnopqrstuvwxyz'];
@@ -25,15 +25,13 @@ describe('parseJson and parseJsonAst', () => {
         expect(ast.start).toEqual({ offset: start[0], line: start[1], character: start[2] });
         expect(ast.end).toEqual({ offset: end[0], line: end[1], character: end[2] });
         expect(ast.value).toEqual(JSON.parse(n));
-        expect(parseJson(n)).toEqual(JSON.parse(n));
         expect(ast.text).toBe(text === undefined ? n : text);
       });
     }
 
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n)).toThrow();
-        expect(() => parseJson(n)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
@@ -98,15 +96,13 @@ describe('parseJson and parseJsonAst', () => {
         expect(ast.start).toEqual({ offset: start[0], line: start[1], character: start[2] });
         expect(ast.end).toEqual({ offset: end[0], line: end[1], character: end[2] });
         expect(ast.value).toEqual(JSON.parse(n));
-        expect(parseJson(n)).toEqual(JSON.parse(n));
         expect(ast.text).toBe(text === undefined ? n : text);
       });
     }
 
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n)).toThrow();
-        expect(() => parseJson(n)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
@@ -144,15 +140,13 @@ describe('parseJson and parseJsonAst', () => {
         expect(ast.start).toEqual({ offset: start[0], line: start[1], character: start[2] });
         expect(ast.end).toEqual({ offset: end[0], line: end[1], character: end[2] });
         expect(ast.value).toEqual(JSON.parse(n));
-        expect(parseJson(n)).toEqual(JSON.parse(n));
         expect(ast.text).toBe(text === undefined ? n : text);
       });
     }
 
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n)).toThrow();
-        expect(() => parseJson(n)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
@@ -180,7 +174,6 @@ describe('parseJson and parseJsonAst', () => {
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n)).toThrow();
-        expect(() => parseJson(n)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
@@ -223,15 +216,13 @@ describe('parseJson and parseJsonAst', () => {
         expect(ast.start).toEqual({ offset: start[0], line: start[1], character: start[2] });
         expect(ast.end).toEqual({ offset: end[0], line: end[1], character: end[2] });
         expect(ast.value).toEqual(JSON.parse(n));
-        expect(parseJson(n)).toEqual(JSON.parse(n));
         expect(ast.text).toBe(text === undefined ? n : text);
       });
     }
 
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n)).toThrow();
-        expect(() => parseJson(n)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
@@ -269,15 +260,13 @@ describe('parseJson and parseJsonAst', () => {
         expect(ast.start).toEqual({ offset: start[0], line: start[1], character: start[2] });
         expect(ast.end).toEqual({ offset: end[0], line: end[1], character: end[2] });
         expect(ast.value).toEqual(JSON.parse(n));
-        expect(parseJson(n)).toEqual(JSON.parse(n));
         expect(ast.text).toBe(text === undefined ? n : text);
       });
     }
 
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n)).toThrow();
-        expect(() => parseJson(n)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
@@ -322,76 +311,15 @@ describe('parseJson and parseJsonAst', () => {
         expect(ast.start).toEqual({ offset: start[0], line: start[1], character: start[2] });
         expect(ast.end).toEqual({ offset: end[0], line: end[1], character: end[2] });
         expect(ast.value).toEqual(value);
-        expect(parseJson(n, JsonParseMode.Loose)).toEqual(value);
         expect(ast.text).toBe(text === undefined ? n : text);
       });
     }
 
     for (const n of errors) {
       it(`errors for ${JSON.stringify(n)}`, () => {
         expect(() => parseJsonAst(n, JsonParseMode.Loose)).toThrow();
-        expect(() => parseJson(n, JsonParseMode.Loose)).toThrow();
         expect(() => JSON.parse(n)).toThrow();
       });
     }
   });
-
-  describe('complex', () => {
-    it('strips comments', () => {
-      expect(
-        parseJson(
-          `
-        // THIS IS A COMMENT
-        {
-          /* THIS IS ALSO A COMMENT */ // IGNORED BECAUSE COMMENT
-          // AGAIN, COMMENT /* THIS SHOULD NOT BE WEIRD
-          "a": "this // should not be a comment",
-          "a2": "this /* should also not be a comment",
-          /* MULTIPLE
-             LINE
-             COMMENT
-             \\o/ */
-          "b" /* COMMENT */: /* YOU GUESSED IT */ 1 // COMMENT
-          , /* STILL VALID */
-          "c": 2
-        }
-      `,
-          JsonParseMode.Loose,
-        ),
-      ).toEqual({
-        a: 'this // should not be a comment',
-        a2: 'this /* should also not be a comment',
-        b: 1,
-        c: 2,
-      });
-    });
-
-    it('works with json5.org example', () => {
-      const input = `{
-        // comments
-        unquoted: 'and you can quote me on that',
-        'singleQuotes': 'I can use "double quotes" here',
-        lineBreaks: "Look, Mom! \\
-No \\\\n's!",
-        hexadecimal: 0xdecaf,
-        leadingDecimalPoint: .8675309, andTrailing: 8675309.,
-        positiveSign: +1,
-        trailingComma: 'in objects', andIn: ['arrays',],
-        "backwardsCompatible": "with JSON",
-      }`;
-
-      expect(parseJson(input, JsonParseMode.Json5)).toEqual({
-        unquoted: 'and you can quote me on that',
-        singleQuotes: 'I can use "double quotes" here',
-        lineBreaks: "Look, Mom! \nNo \\n's!",
-        hexadecimal: 0xdecaf,
-        leadingDecimalPoint: 0.8675309,
-        andTrailing: 8675309,
-        positiveSign: +1,
-        trailingComma: 'in objects',
-        andIn: ['arrays'],
-        backwardsCompatible: 'with JSON',
-      });
-    });
-  });
 });