Class YargsConfigurer

Before invoking commands, this class configures some settings and callbacks in Yargs, including what happens on syntax failures.

Hierarchy

YargsConfigurer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new YargsConfigurer(rootCommand: ICommandDefinition, yargs: any, commandRespParms: ICommandResponseParms, profileManagerFactory: IProfileManagerFactory<ICommandProfileTypeConfiguration>, helpGeneratorFactory: IHelpGeneratorFactory, experimentalCommandDescription: string, rootCommandName: string, commandLine: string, envVariablePrefix: string, promptPhrase: string): YargsConfigurer

- Defined in @zowe/imperative/packages/cmd/src/yargs/YargsConfigurer.ts:32
Parameters
- rootCommand: ICommandDefinition
- yargs: any
- commandRespParms: ICommandResponseParms
- profileManagerFactory: IProfileManagerFactory<ICommandProfileTypeConfiguration>
- helpGeneratorFactory: IHelpGeneratorFactory
- experimentalCommandDescription: string
- rootCommandName: string
- commandLine: string
- envVariablePrefix: string
- promptPhrase: string
Returns YargsConfigurer

Properties

Private commandLine

commandLine: string

Private commandRespParms

commandRespParms: ICommandResponseParms

Private envVariablePrefix

envVariablePrefix: string

Private experimentalCommandDescription

experimentalCommandDescription: string

Private helpGeneratorFactory

helpGeneratorFactory: IHelpGeneratorFactory

Private profileManagerFactory

profileManagerFactory: IProfileManagerFactory<ICommandProfileTypeConfiguration>

Private promptPhrase

promptPhrase: string

Private rootCommand

rootCommand: ICommandDefinition

Private rootCommandName

rootCommandName: string

Private yargs

yargs: any

Methods

Private buildFailedCommandDefinition

buildFailedCommandDefinition(): ICommandDefinition

- Defined in @zowe/imperative/packages/cmd/src/yargs/YargsConfigurer.ts:277
Define failed command with the current command line arguments.

Returns ICommandDefinition

Failed command definition object

Private buildFailureMessage

buildFailureMessage(closestCommand?: string): string

- Defined in @zowe/imperative/packages/cmd/src/yargs/YargsConfigurer.ts:223
Builds the failure message that is passed to the failedCommand handler

Parameters
- Optional closestCommand: string
Returns string
- Returns the failure message

configure

configure(): void

- Defined in @zowe/imperative/packages/cmd/src/yargs/YargsConfigurer.ts:46
Returns void

Private getClosestCommand

getClosestCommand(attemptedCommand: string): any

- Defined in @zowe/imperative/packages/cmd/src/yargs/YargsConfigurer.ts:303
Parameters
- attemptedCommand: string
Returns any

Private getResponseFormat

getResponseFormat(argv: Arguments): COMMAND_RESPONSE_FORMAT

- Defined in @zowe/imperative/packages/cmd/src/yargs/YargsConfigurer.ts:320
Get the command response format based on whether --rfj is set.

Parameters
- argv: Arguments
  
  Yargs arguments object
Returns COMMAND_RESPONSE_FORMAT

Generated using TypeDoc