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

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * 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 { JsonValue, tags } from '@angular-devkit/core';
import { v4 as uuidV4 } from 'uuid';
import { Command } from '../models/command';
import { Arguments, CommandScope } from '../models/interface';
import { getWorkspaceRaw, migrateLegacyGlobalConfig, validateWorkspace } from '../utilities/config';
import { JSONFile, parseJson } from '../utilities/json-file';
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())],

  ['cli.cache.enabled', undefined],
  ['cli.cache.environment', undefined],
  ['cli.cache.path', undefined],
]);

/**
 * Splits a JSON path string into fragments. Fragments can be used to get the value referenced
 * by the path. For example, a path of "a[3].foo.bar[2]" would give you a fragment array of
 * ["a", 3, "foo", "bar", 2].
 * @param path The JSON string to parse.
 * @returns {(string|number)[]} The fragments for the string.
 * @private
 */
function parseJsonPath(path: string): (string | number)[] {
  const fragments = (path || '').split(/\./g);
  const result: (string | number)[] = [];

  while (fragments.length > 0) {
    const fragment = fragments.shift();
    if (fragment == undefined) {
      break;
    }

    const match = fragment.match(/([^[]+)((\[.*\])*)/);
    if (!match) {
      throw new Error('Invalid JSON path.');
    }

    result.push(match[1]);
    if (match[2]) {
      const indices = match[2]
        .slice(1, -1)
        .split('][')
        .map((x) => (/^\d$/.test(x) ? +x : x.replace(/"|'/g, '')));
      result.push(...indices);
    }
  }

  return result.filter((fragment) => fragment != null);
}

function normalizeValue(value: string | undefined | boolean | number): JsonValue | undefined {
  const valueString = `${value}`.trim();
  switch (valueString) {
    case 'true':
      return true;
    case 'false':
      return false;
    case 'null':
      return null;
    case 'undefined':
      return undefined;
  }

  if (isFinite(+valueString)) {
    return +valueString;
  }

  return parseJson(valueString) ?? value ?? undefined;
}

export class ConfigCommand extends Command<ConfigCommandSchema> {
  public async run(options: ConfigCommandSchema & Arguments) {
    const level = options.global ? 'global' : 'local';

    if (!options.global) {
      await this.validateScope(CommandScope.InProject);
    }

    let [config] = getWorkspaceRaw(level);

    if (options.global && !config) {
      try {
        if (migrateLegacyGlobalConfig()) {
          config = getWorkspaceRaw(level)[0];
          this.logger.info(tags.oneLine`
            We found a global configuration that was used in Angular CLI 1.
            It has been automatically migrated.`);
        }
      } catch {}
    }

    if (options.value == undefined) {
      if (!config) {
        this.logger.error('No config found.');

        return 1;
      }

      return this.get(config, options);
    } else {
      return this.set(options);
    }
  }

  private get(jsonFile: JSONFile, options: ConfigCommandSchema) {
    let value;
    if (options.jsonPath) {
      value = jsonFile.get(parseJsonPath(options.jsonPath));
    } else {
      value = jsonFile.content;
    }

    if (value === undefined) {
      this.logger.error('Value cannot be found.');

      return 1;
    } else if (typeof value === 'string') {
      this.logger.info(value);
    } else {
      this.logger.info(JSON.stringify(value, null, 2));
    }

    return 0;
  }

  private async set(options: ConfigCommandSchema) {
    if (!options.jsonPath?.trim()) {
      throw new Error('Invalid Path.');
    }

    if (
      options.global &&
      !options.jsonPath.startsWith('schematics.') &&
      !validCliPaths.has(options.jsonPath)
    ) {
      throw new Error('Invalid Path.');
    }

    const [config, configPath] = getWorkspaceRaw(options.global ? 'global' : 'local');
    if (!config || !configPath) {
      this.logger.error('Confguration file cannot be found.');

      return 1;
    }

    const jsonPath = parseJsonPath(options.jsonPath);
    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.');

      return 1;
    }

    try {
      await validateWorkspace(parseJson(config.content));
    } catch (error) {
      this.logger.fatal(error.message);

      return 1;
    }

    config.save();

    return 0;
  }
}