Class YargsDefiner

constructor

• new YargsDefiner(yargsInstance: Argv, primaryHighlightColor: string, rootCommandName: string, commandLine: string, envVariablePrefix: string, profileManagerFactory: IProfileManagerFactory<ICommandProfileTypeConfiguration>, helpGeneratorFactory: IHelpGeneratorFactory, experimentalCommandDescription: string, promptPhrase: string): YargsDefiner

• Build the definer - maintains the Yargs instance for all future definitions.

  Parameters

  • yargsInstance: Argv

  • primaryHighlightColor: string

    main color to highlight help text headings and other text with

  • rootCommandName: string

    the display name of the root command (e.g. "bright" or "sample-cli")

  • commandLine: string

  • envVariablePrefix: string

    the environment variable prefix

  • profileManagerFactory: IProfileManagerFactory<ICommandProfileTypeConfiguration>

    profile manager factory that can be used to instantiate new profile managers

  • helpGeneratorFactory: IHelpGeneratorFactory

    help generator factory that can be used to instantiate new help generators

  • experimentalCommandDescription: string

    optionally overridden experimental command description to propagate to yargs services

  • promptPhrase: string

  Returns YargsDefiner