refactor(@schematics/angular): use jsonc-parser instead of devkit parser

Author: alan-agius4

packages/angular/cli/commands/config-impl.ts

@@ -16,50 +16,15 @@ import {
   validateWorkspace,
 } from '../utilities/config';
 import { JSONFile, parseJson } from '../utilities/json-file';
-import { Schema as ConfigCommandSchema, Value as ConfigCommandSchemaValue } from './config';
-
-function _validateBoolean(value: string) {
-  if (('' + value).trim() === 'true') {
-    return true;
-  } else if (('' + value).trim() === 'false') {
-    return false;
-  } else {
-    throw new Error(`Invalid value type; expected Boolean, received ${JSON.stringify(value)}.`);
-  }
-}
-function _validateString(value: string) {
-  return value;
-}
-function _validateAnalytics(value: string) {
-  if (value === '') {
-    // Disable analytics.
-    return null;
-  } else {
-    return value;
-  }
-}
-function _validateAnalyticsSharingUuid(value: string) {
-  if (value == '') {
-    return uuidV4();
-  } else {
-    return value;
-  }
-}
-function _validateAnalyticsSharingTracking(value: string) {
-  if (!value.match(/^GA-\d+-\d+$/)) {
-    throw new Error(`Invalid GA property ID: ${JSON.stringify(value)}.`);
-  }
-
-  return value;
-}
-
-const validCliPaths = new Map<string, (arg: string) => JsonValue>([
-  ['cli.warnings.versionMismatch', _validateBoolean],
-  ['cli.defaultCollection', _validateString],
-  ['cli.packageManager', _validateString],
-  ['cli.analytics', _validateAnalytics],
-  ['cli.analyticsSharing.tracking', _validateAnalyticsSharingTracking],
-  ['cli.analyticsSharing.uuid', _validateAnalyticsSharingUuid],
+import { Schema as ConfigCommandSchema } from './config';
+
+const validCliPaths = new Map<string, ((arg: string | number | boolean | undefined) => string) | undefined>([
+  ['cli.warnings.versionMismatch', undefined],
+  ['cli.defaultCollection', undefined],
+  ['cli.packageManager', undefined],
+  ['cli.analytics', undefined],
+  ['cli.analyticsSharing.tracking', undefined],
+  ['cli.analyticsSharing.uuid', v => v ? `${v}` : uuidV4()],
 ]);
 
 /**
@@ -98,21 +63,17 @@ function parseJsonPath(path: string): (string | number)[] {
   return result.filter(fragment => fragment != null);
 }
 
-function normalizeValue(value: ConfigCommandSchemaValue, path: string): JsonValue {
-  const cliOptionType = validCliPaths.get(path);
-  if (cliOptionType) {
-    return cliOptionType('' + value);
-  }
-
-  if (typeof value === 'string') {
-    try {
-      return parseJson(value);
-    } catch (e) {
-      throw e;
-    }
+function normalizeValue(value: string | undefined | boolean | number): JsonValue | undefined {
+  const valueString = `${value}`.trim();
+  if (valueString === 'true') {
+    return true;
+  } else if (valueString === 'false') {
+    return false;
+  } else if (isFinite(+valueString)) {
+    return +valueString;
   }
 
-  return value;
+  return value || undefined;
 }
 
 export class ConfigCommand extends Command<ConfigCommandSchema> {
@@ -133,7 +94,7 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
             We found a global configuration that was used in Angular CLI 1.
             It has been automatically migrated.`);
         }
-      } catch {}
+      } catch { }
     }
 
     if (options.value == undefined) {
@@ -171,7 +132,7 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
   }
 
   private async set(options: ConfigCommandSchema) {
-    if (!options.jsonPath || !options.jsonPath.trim()) {
+    if (!options.jsonPath?.trim()) {
       throw new Error('Invalid Path.');
     }
 
@@ -190,11 +151,9 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
       return 1;
     }
 
-    // TODO: Modify & save without destroying comments
-    const value = normalizeValue(options.value || '', options.jsonPath);
-
     const jsonPath = parseJsonPath(options.jsonPath);
-    const modified = config.modify(jsonPath, value);
+    const value = validCliPaths.get(options.jsonPath)?.(options.value) ?? options.value;
+    const modified = config.modify(jsonPath, normalizeValue(value));
 
     if (!modified) {
       this.logger.error('Value cannot be found.');
@@ -210,7 +169,7 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
       return 1;
     }
 
-    config.write();
+    config.save();
 
     return 0;
   }

packages/angular/cli/lib/config/schema.json

@@ -64,6 +64,20 @@
         "analytics": {
           "type": ["boolean", "string"],
           "description": "Share anonymous usage data with the Angular Team at Google."
+        },
+        "analyticsSharing": {
+          "type": "object",
+          "properties": {
+            "tracking": {
+              "description": "Analytics sharing info tracking ID.",
+              "type": "string",
+              "pattern": "^GA-\\d+-\\d+$"
+            },
+            "uuid": {
+              "description": "Analytics sharing info universally unique identifier.",
+              "type": "string"
+            }
+          }
         }
       },
       "additionalProperties": false

packages/angular/cli/models/analytics.ts

@@ -367,7 +367,7 @@ export function setAnalyticsConfig(level: 'global' | 'local', value: string | bo
   }
 
   config.modify(['cli', 'analytics'], value);
-  config.write();
+  config.save();
 
   analyticsDebug('done');
 

packages/schematics/angular/application/index_spec.ts

@@ -6,16 +6,16 @@
  * found in the LICENSE file at https://angular.io/license
  */
 // tslint:disable:no-big-function
-import { JsonParseMode, parseJson } from '@angular-devkit/core';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+import { parse as parseJson } from 'jsonc-parser';
 import { latestVersions } from '../utility/latest-versions';
 import { getFileContent } from '../utility/test';
 import { Schema as WorkspaceOptions } from '../workspace/schema';
 import { Schema as ApplicationOptions, Style, ViewEncapsulation } from './schema';
 
 // tslint:disable-next-line: no-any
 function readJsonFile(tree: UnitTestTree, path: string): any {
-  return parseJson(tree.readContent(path).toString(), JsonParseMode.Loose);
+  return parseJson(tree.readContent(path).toString());
 }
 
 describe('Application Schematic', () => {

packages/schematics/angular/library/index.ts

@@ -5,7 +5,7 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { JsonParseMode, join, normalize, parseJson, strings } from '@angular-devkit/core';
+import { join, normalize, strings } from '@angular-devkit/core';
 import {
   Rule,
   SchematicContext,
@@ -22,6 +22,7 @@ import {
 } from '@angular-devkit/schematics';
 import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
 import { NodeDependencyType, addPackageJsonDependency } from '../utility/dependencies';
+import { JSONFile } from '../utility/json-file';
 import { latestVersions } from '../utility/latest-versions';
 import { applyLintFix } from '../utility/lint-fix';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
@@ -30,45 +31,14 @@ import { getWorkspace, updateWorkspace } from '../utility/workspace';
 import { Builders, ProjectType } from '../utility/workspace-models';
 import { Schema as LibraryOptions } from './schema';
 
-interface UpdateJsonFn<T> {
-  (obj: T): T | void;
-}
-
-type TsConfigPartialType = {
-  compilerOptions: {
-    baseUrl: string,
-    paths: {
-      [key: string]: string[];
-    },
-  },
-};
-
-function updateJsonFile<T>(host: Tree, path: string, callback: UpdateJsonFn<T>): Tree {
-  const source = host.read(path);
-  if (source) {
-    const sourceText = source.toString('utf-8');
-    const json = parseJson(sourceText, JsonParseMode.Loose);
-    callback(json as {} as T);
-    host.overwrite(path, JSON.stringify(json, null, 2));
-  }
-
-  return host;
-}
-
 function updateTsConfig(packageName: string, ...paths: string[]) {
-
   return (host: Tree) => {
     if (!host.exists('tsconfig.json')) { return host; }
 
-    return updateJsonFile(host, 'tsconfig.json', (tsconfig: TsConfigPartialType) => {
-      if (!tsconfig.compilerOptions.paths) {
-        tsconfig.compilerOptions.paths = {};
-      }
-      if (!tsconfig.compilerOptions.paths[packageName]) {
-        tsconfig.compilerOptions.paths[packageName] = [];
-      }
-      tsconfig.compilerOptions.paths[packageName].push(...paths);
-    });
+    const file = new JSONFile(host, 'tsconfig.json');
+    const jsonPath = ['compilerOptions', 'paths', packageName];
+    const value = file.get(jsonPath);
+    file.modify(jsonPath, Array.isArray(value) ? [...value, ...paths] : paths);
   };
 }
 

packages/schematics/angular/library/index_spec.ts

@@ -6,8 +6,8 @@
  * found in the LICENSE file at https://angular.io/license
  */
 // tslint:disable:no-big-function
-import { JsonParseMode, parseJson } from '@angular-devkit/core';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+import { parse as parseJson } from 'jsonc-parser';
 import { getFileContent } from '../../angular/utility/test';
 import { Schema as ComponentOptions } from '../component/schema';
 import { latestVersions } from '../utility/latest-versions';
@@ -16,7 +16,7 @@ import { Schema as GenerateLibrarySchema } from './schema';
 
 // tslint:disable-next-line: no-any
 function getJsonFileContent(tree: UnitTestTree, path: string): any {
-  return parseJson(tree.readContent(path).toString(), JsonParseMode.Loose);
+  return parseJson(tree.readContent(path).toString());
 }
 
 describe('Library Schematic', () => {

packages/schematics/angular/migrations/update-10/remove-solution-style-tsconfig_spec.ts

@@ -5,9 +5,9 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { JsonParseMode, parseJson } from '@angular-devkit/core';
 import { EmptyTree } from '@angular-devkit/schematics';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+import { parse as parseJson } from 'jsonc-parser';
 import { Builders, ProjectType, WorkspaceSchema } from '../../utility/workspace-models';
 
 describe('Migration to remove "Solution Style" tsconfig', () => {
@@ -24,8 +24,7 @@ describe('Migration to remove "Solution Style" tsconfig', () => {
 
   // tslint:disable-next-line: no-any
   function readJsonFile(tree: UnitTestTree, filePath: string): any {
-    // tslint:disable-next-line: no-any
-    return parseJson(tree.readContent(filePath).toString(), JsonParseMode.Loose) as any;
+    return parseJson(tree.readContent(filePath).toString());
   }
 
   function createWorkSpaceConfig(tree: UnitTestTree) {

packages/schematics/angular/migrations/update-10/update-module-and-target-compiler-options_spec.ts

@@ -5,9 +5,9 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { JsonParseMode, parseJson } from '@angular-devkit/core';
 import { EmptyTree } from '@angular-devkit/schematics';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+import { parse as parseJson } from 'jsonc-parser';
 import { Builders, ProjectType, WorkspaceSchema } from '../../utility/workspace-models';
 
 describe('Migration to update target and module compiler options', () => {
@@ -24,8 +24,7 @@ describe('Migration to update target and module compiler options', () => {
 
   // tslint:disable-next-line: no-any
   function readJsonFile(tree: UnitTestTree, filePath: string): any {
-    // tslint:disable-next-line: no-any
-    return parseJson(tree.readContent(filePath).toString(), JsonParseMode.Loose) as any;
+    return parseJson(tree.readContent(filePath).toString());
   }
 
   function createWorkSpaceConfig(tree: UnitTestTree) {

packages/schematics/angular/migrations/update-6/index.ts

@@ -8,12 +8,10 @@
 import {
   JsonArray,
   JsonObject,
-  JsonParseMode,
   Path,
   join,
   logging,
   normalize,
-  parseJson,
   tags,
 } from '@angular-devkit/core';
 import {
@@ -24,6 +22,7 @@ import {
   chain,
 } from '@angular-devkit/schematics';
 import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
+import { parse as parseJson } from 'jsonc-parser';
 import {
   NodeDependency,
   NodeDependencyType,
@@ -745,7 +744,7 @@ export default function (): Rule {
     if (configBuffer == null) {
       throw new SchematicsException(`Could not find configuration file (${configPath})`);
     }
-    const config = parseJson(configBuffer.toString(), JsonParseMode.Loose);
+    const config = parseJson(configBuffer.toString());
 
     if (typeof config != 'object' || Array.isArray(config) || config === null) {
       throw new SchematicsException('Invalid angular-cli.json configuration; expected an object.');

packages/schematics/angular/migrations/update-9/update-app-tsconfigs_spec.ts

@@ -6,14 +6,14 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { JsonParseMode, parseJson } from '@angular-devkit/core';
 import { EmptyTree } from '@angular-devkit/schematics';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+import { parse as parseJson } from 'jsonc-parser';
 import { getWorkspaceTargets, updateWorkspaceTargets } from './update-workspace-config_spec';
 
 // tslint:disable-next-line: no-any
 function readJsonFile(tree: UnitTestTree, path: string): any {
-  return parseJson(tree.readContent(path).toString(), JsonParseMode.Loose);
+  return parseJson(tree.readContent(path).toString());
 }
 
 function overrideJsonFile(tree: UnitTestTree, path: string, newContent: object) {

packages/schematics/angular/universal/index_spec.ts

@@ -5,8 +5,8 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { JsonParseMode, parseJson } from '@angular-devkit/core';
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
+import { parse as parseJson } from 'jsonc-parser';
 import { Schema as ApplicationOptions, Style } from '../application/schema';
 import { NodeDependencyType, addPackageJsonDependency } from '../utility/dependencies';
 import { Schema as WorkspaceOptions } from '../workspace/schema';
@@ -88,7 +88,7 @@ describe('Universal Schematic', () => {
     const filePath = '/tsconfig.server.json';
     expect(tree.exists(filePath)).toEqual(true);
     // tslint:disable-next-line: no-any
-    const contents = parseJson(tree.readContent(filePath).toString(), JsonParseMode.Loose) as any;
+    const contents = parseJson(tree.readContent(filePath).toString()) as any;
     expect(contents).toEqual({
       extends: './tsconfig.app.json',
       compilerOptions: {
@@ -114,7 +114,7 @@ describe('Universal Schematic', () => {
     const filePath = '/projects/bar/tsconfig.server.json';
     expect(tree.exists(filePath)).toEqual(true);
     // tslint:disable-next-line: no-any
-    const contents = parseJson(tree.readContent(filePath).toString(), JsonParseMode.Loose) as any;
+    const contents = parseJson(tree.readContent(filePath).toString()) as any;
     expect(contents).toEqual({
       extends: './tsconfig.app.json',
       compilerOptions: {