parse-args.ts

import * as commander from 'commander'
import { EnvCmdOptions } from './types'
import { parseArgList } from './utils'

// Use commonjs require to prevent a weird folder hierarchy in dist
const packageJson = require('../package.json') /* eslint-disable-line */

/**
* Parses the arguments passed into the cli
*/
export function parseArgs (args: string[]): EnvCmdOptions {
  // Run the initial arguments through commander in order to determine
  // which value in the args array is the `command` to execute
  let program = parseArgsUsingCommander(args)
  const command = program.args[0]
  // Grab all arguments after the `command` in the args array
  const commandArgs = args.splice(args.indexOf(command) + 1)

  // Reprocess the args with the command and command arguments removed
  program = parseArgsUsingCommander(args.slice(0, args.indexOf(command)))

  // Set values for provided options
  let noOverride = false
  // In commander `no-` negates the original value `override`
  if (program.override === false) {
    noOverride = true
  }
  let useShell = false
  if (program.useShell === true) {
    useShell = true
  }
  let expandEnvs = false
  if (program.expandEnvs === true) {
    expandEnvs = true
  }
  let recursive = false
  if (program.recursive === true) {
    recursive = true
  }
  let verbose = false
  if (program.verbose === true) {
    verbose = true
  }
  let silent = false
  if (program.silent === true) {
    silent = true
  }

  let rc: any
  if (program.environments !== undefined && program.environments.length !== 0) {
    rc = {
      environments: program.environments,
      filePath: program.rcFile
    }
  }

  let envFile: any
  if (program.file !== undefined) {
    envFile = {
      filePath: program.file,
      fallback: program.fallback
    }
  }

  const options = {
    command,
    commandArgs,
    envFile,
    rc,
    options: {
      expandEnvs,
      recursive,
      noOverride,
      silent,
      useShell,
      verbose
    }
  }
  if (verbose) {
    console.info(`Options: ${JSON.stringify(options, null, 0)}`)
  }
  return options
}

export function parseArgsUsingCommander (args: string[]): commander.Command {
  const program = new commander.Command()
  return program
    .version(packageJson.version, '-v, --version')
    .usage('[options] <command> [...args]')
    .option('-e, --environments [env1,env2,...]', 'The rc file environment(s) to use', parseArgList)
    .option('-f, --file [path]', 'Custom env file path (default path: ./.env)')
    .option('--fallback', 'Fallback to default env file path, if custom env file path not found')
    .option('--no-override', 'Do not override existing environment variables')
    .option('-r, --rc-file [path]', 'Custom rc file path (default path: ./.env-cmdrc(|.js|.json)')
    .option('--silent', 'Ignore any env-cmd errors and only fail on executed program failure.')
    .option('--use-shell', 'Execute the command in a new shell with the given environment')
    .option('--verbose', 'Print helpful debugging information')
    .option('-x, --expand-envs', 'Replace $var and $\\{var\\} in args and command with environment variables')
    .option('--recursive', 'Replace $var and $\\{var\\} in env file with the referenced environment variable')
    .allowUnknownOption(true)
    .parse(['_', '_', ...args])
}