CliEvent = object
  srcCodeOrigin*: InstantiationInfo
  pass*: TCmdLinePass
  case kind*: CliEventKind
  of cliEvtErrInvalidCommand, cliEvtErrCmdExpectedNoAdditionalArgs,
     cliEvtErrUnexpectedRunOpt:
      cmd*: string
      unexpectedArgs*: string

  of cliEvtErrFlagArgForbidden, cliEvtErrFlagArgExpectedFromList,
     cliEvtErrFlagArgNotFromValidList:
      flag*: CliFlagKind
      givenFlg*: string
      givenArg*: string

  of cliEvtErrRunCmdFailed, cliEvtErrGenDependFailed:
      shellCmd*: string
      exitCode*: int

  of cliEvtErrFlagProcessing, cliEvtWarnSwitchValDeprecatedNoop:
      origParseOptKey*, origParseOptVal*: string
      procResult*: ProcSwitchResult

  of cliEvtHintPathAdded:
      pathAdded*: string

  of cliEvtErrNoCliParamsProvided, cliEvtErrCmdMissing:
      nil

  

CliEventKind = enum
  cliEvtErrInvalidCommand, cliEvtErrCmdMissing, cliEvtErrCmdExpectedNoAdditionalArgs, ## flag disallows additional args
  cliEvtErrFlagArgExpectedFromList, ## flag expected arg from an allow/valid list, but got none
  cliEvtErrFlagArgNotFromValidList, ## flag expects arg from an allow/valid list
  cliEvtErrRunCmdFailed, cliEvtErrGenDependFailed, cliEvtErrUnexpectedRunOpt,
  cliEvtErrFlagArgForbidden, cliEvtErrFlagProcessing,
  cliEvtErrNoCliParamsProvided, cliEvtWarnSwitchValDeprecatedNoop, cliEvtHintPathAdded ## currently only triggered if nimble adds a path

CliFlagKind = enum
  cliFlagVersion, cliFlagHelp, cliFlagHelpFull, cliFlagHelpAdvanced,
  cliFlagMsgFormat

CmdOutputKind = enum
  cmdOutUser,               ## a command's primary output, e.g. dump's data dump
  cmdOutStatus,             ## command's status, e.g. build success message
  cmdOutUserProf,           ## user requested profiling output
  cmdOutInternalDbg          ## explicitly secondary output for compiler tracing

proc cliEventLogger(conf: ConfigRef; evt: CliEvent) {.
    ...raises: [ValueError, IOError], tags: [WriteIOEffect].}

func cliFmt(conf: ConfigRef; info: TLineInfo; useColor: bool): string {.
    ...raises: [ValueError], tags: [].}

func cliFmtLineInfo(filename: string; line, col: int; useColor: bool): string {.
    ...raises: [ValueError], tags: [].}

func cliFmtMsgOrigin(origin: InstantiationInfo; showSuffix, useColor: bool): string {.
    ...raises: [ValueError], tags: [].}

func cliFmtSrcCodeOrigin(origin: InstantiationInfo; useColor: bool): string {.
    ...raises: [ValueError], tags: [].}

proc logError(conf: ConfigRef; evt: CliEvent) {....raises: [ValueError, IOError],
    tags: [WriteIOEffect].}

proc logError(conf: ConfigRef; msg: string; srcLoc = instLoc()) {.
    ...raises: [ValueError, IOError], tags: [WriteIOEffect].}

proc logExecStart(conf: ConfigRef; cmd: string; srcLoc = instLoc()) {.
    ...raises: [ValueError, IOError], tags: [WriteIOEffect].}

proc logGcStats(conf: ConfigRef; stats: string; srcLoc = instLoc()) {.
    ...raises: [ValueError, IOError], tags: [WriteIOEffect].}

proc processArgument(pass: TCmdLinePass; p: OptParser; argsCount: var int;
                     config: ConfigRef): bool {....raises: [], tags: [].}

proc processCmdLine(pass: TCmdLinePass; cmd: openArray[string];
                    config: ConfigRef) {....raises: [ValueError, IOError,
    Exception, OSError, KeyError, ERecoverableError, EOFError], tags: [
    WriteIOEffect, RootEffect, ReadEnvEffect, ReadIOEffect, ReadDirEffect,
    WriteDirEffect, WriteEnvEffect].}

proc showMsg(conf: ConfigRef; msg: string) {....raises: [IOError],
    tags: [WriteIOEffect].}

func stylize(str: string; color: ForegroundColor; style: Style): string {.
    inline, ...raises: [ValueError], tags: [].}

func stylize(str: string; color: ForegroundColor; styles: set[Style] = {}): string {.
    ...raises: [ValueError], tags: [].}

proc write(conf: ConfigRef; dest: static[CmdOutputKind]; msg: string)

proc writeln(conf: ConfigRef; dest: static[CmdOutputKind]; msg: string)

proc writeUsage(conf: ConfigRef) {....raises: [IOError], tags: [WriteIOEffect].}

iterator procSwitchResultToEvents(conf: ConfigRef; pass: TCmdLinePass;
                                  origParseOptKey, origParseOptVal: string;
                                  r: ProcSwitchResult): CliEvent {....raises: [],
    tags: [].}