unset.ts

import {BaseCommand}                              from '@yarnpkg/cli';
import {Configuration, StreamReport, MessageName} from '@yarnpkg/core';
import {Command, Option, Usage, UsageError}       from 'clipanion';
import cloneDeep                                  from 'lodash/cloneDeep';
import hasPath                                    from 'lodash/has';
import unsetPath                                  from 'lodash/unset';

// eslint-disable-next-line arca/no-default-export
export default class ConfigUnsetCommand extends BaseCommand {
  static paths = [
    [`config`, `unset`],
  ];

  static usage: Usage = Command.Usage({
    description: `unset a configuration setting`,
    details: `
      This command will unset a configuration setting.
    `,
    examples: [[
      `Unset a simple configuration setting`,
      `yarn config unset initScope`,
    ], [
      `Unset a complex configuration setting`,
      `yarn config unset packageExtensions`,
    ], [
      `Unset a nested configuration setting`,
      `yarn config unset npmScopes.company.npmRegistryServer`,
    ]],
  });

  home = Option.Boolean(`-H,--home`, false, {
    description: `Update the home configuration instead of the project configuration`,
  });

  name = Option.String();

  async execute() {
    const configuration = await Configuration.find(this.context.cwd, this.context.plugins);

    const assertProjectCwd = () => {
      if (!configuration.projectCwd)
        throw new UsageError(`This command must be run from within a project folder`);

      return configuration.projectCwd;
    };

    const name = this.name.replace(/[.[].*$/, ``);
    const path = this.name.replace(/^[^.[]*\.?/, ``);

    const setting = configuration.settings.get(name);
    if (typeof setting === `undefined`)
      throw new UsageError(`Couldn't find a configuration settings named "${name}"`);

    const updateConfiguration: (patch: ((current: any) => any)) => Promise<boolean> =
      this.home
        ? patch => Configuration.updateHomeConfiguration(patch)
        : patch => Configuration.updateConfiguration(assertProjectCwd(), patch);

    const report = await StreamReport.start({
      configuration,
      includeFooter: false,
      stdout: this.context.stdout,
    }, async report => {
      let bailedOutEarly = false;
      await updateConfiguration(current => {
        if (!hasPath(current, this.name)) {
          report.reportWarning(MessageName.UNNAMED, `Configuration doesn't contain setting ${this.name}; there is nothing to unset`);
          bailedOutEarly = true;
          return current;
        }

        const clone = path
          ? cloneDeep(current)
          : {...current};

        unsetPath(clone, this.name);
        return clone;
      });

      // We can't show the success message in the callback as we must first wait for the new configuration to be persisted
      if (!bailedOutEarly) {
        report.reportInfo(MessageName.UNNAMED, `Successfully unset ${this.name}`);
      }
    });

    return report.exitCode();
  }
}