xref: /expo/packages/@expo/cli/src/utils/variadic.ts (revision e0694585)

import { CommandError } from '../utils/errors';

const debug = require('debug')('expo:utils:variadic') as typeof console.log;

/** Given a list of CLI args, return a sorted set of args based on categories used in a complex command. */
export function parseVariadicArguments(argv: string[]): {
  variadic: string[];
  extras: string[];
  flags: Record<string, boolean>;
} {
  const variadic: string[] = [];
  const flags: Record<string, boolean> = {};

  for (const arg of argv) {
    if (!arg.startsWith('-')) {
      variadic.push(arg);
    } else if (arg === '--') {
      break;
    } else {
      flags[arg] = true;
    }
  }

  // Everything after `--` that is not an option is passed to the underlying install command.
  const extras: string[] = [];

  const extraOperator = argv.indexOf('--');
  if (extraOperator > -1 && argv.length > extraOperator + 1) {
    const extraArgs = argv.slice(extraOperator + 1);
    if (extraArgs.includes('--')) {
      throw new CommandError('BAD_ARGS', 'Unexpected multiple --');
    }
    extras.push(...extraArgs);
    debug('Extra arguments: ' + extras.join(', '));
  }

  debug(`Parsed arguments (variadic: %O, flags: %O, extra: %O)`, variadic, flags, extras);

  return {
    variadic,
    flags,
    extras,
  };
}

export function assertUnexpectedObjectKeys(keys: string[], obj: Record<string, any>): void {
  const unexpectedKeys = Object.keys(obj).filter((key) => !keys.includes(key));
  if (unexpectedKeys.length > 0) {
    throw new CommandError('BAD_ARGS', `Unexpected: ${unexpectedKeys.join(', ')}`);
  }
}

export function assertUnexpectedVariadicFlags(
  expectedFlags: string[],
  { extras, flags, variadic }: ReturnType<typeof parseVariadicArguments>,
  prefixCommand = ''
) {
  const unexpectedFlags = Object.keys(flags).filter((key) => !expectedFlags.includes(key));

  if (unexpectedFlags.length > 0) {
    const intendedFlags = Object.entries(flags)
      .filter(([key]) => expectedFlags.includes(key))
      .map(([key]) => key);

    const cmd = [
      prefixCommand,
      ...variadic,
      ...intendedFlags,
      '--',
      ...extras.concat(unexpectedFlags),
    ].join(' ');

    throw new CommandError(
      'BAD_ARGS',
      `Unexpected: ${unexpectedFlags.join(', ')}\nDid you mean: ${cmd.trim()}`
    );
  }
}