Class Help

constructor

• new Help(): Help

  Returns Help

OptionalhelpWidth

minWidthToWrap

showGlobalOptions

sortOptions

sortSubcommands

argumentDescription

• argumentDescription(argument: Argument): string

  Get the argument description to show in the list of arguments.

  Parameters

  • argument: Argument

  Returns string

argumentTerm

• argumentTerm(argument: Argument): string

  Get the argument term to show in the list of arguments.

  Parameters

  • argument: Argument

  Returns string

boxWrap

• boxWrap(str: string, width: number): string

  Wrap a string at whitespace, preserving existing line breaks. Wrapping is skipped if the width is less than minWidthToWrap.

  Parameters

  • str: string
  • width: number

  Returns string

commandDescription

• commandDescription(cmd: Command): string

  Get the description for the command.

  Parameters

  • cmd: Command

  Returns string

commandUsage

• commandUsage(cmd: Command): string

  Get the command usage to be displayed at the top of the built-in help.

  Parameters

  • cmd: Command

  Returns string

displayWidth

• displayWidth(str: string): number

  Return display width of string, ignoring ANSI escape sequences. Used in padding and wrapping calculations.

  Parameters

  • str: string

  Returns number

formatHelp

• formatHelp(cmd: Command, helper: Help): string

  Generate the built-in help text.

  Parameters

  • cmd: Command
  • helper: Help

  Returns string

formatItem

• formatItem(
      term: string,
      termWidth: number,
      description: string,
      helper: Help,
  ): string

  Format the "item", which consists of a term and description. Pad the term and wrap the description, indenting the following lines.

  So "TTT", 5, "DDD DDDD DD DDD" might be formatted for this.helpWidth=17 like so: TTT DDD DDDD DD DDD

  Parameters

  • term: string
  • termWidth: number
  • description: string
  • helper: Help

  Returns string

formatItemList

• formatItemList(heading: string, items: string[], helper: Help): string[]

  Format a list of items, given a heading and an array of formatted items.

  Parameters

  • heading: string
  • items: string[]
  • helper: Help

  Returns string[]

groupItems

• groupItems<T extends Command | Option>(
      unsortedItems: T[],
      visibleItems: T[],
      getGroup: (item: T) => string,
  ): Map<string, T[]>

  Group items by their help group heading.

  Type Parameters

  • T extends Command | Option

  Parameters

  • unsortedItems: T[]
  • visibleItems: T[]
  • getGroup: (item: T) => string

  Returns Map<string, T[]>

longestArgumentTermLength

• longestArgumentTermLength(cmd: Command, helper: Help): number

  Get the longest argument term length.

  Parameters

  • cmd: Command
  • helper: Help

  Returns number

longestGlobalOptionTermLength

• longestGlobalOptionTermLength(cmd: Command, helper: Help): number

  Get the longest global option term length.

  Parameters

  • cmd: Command
  • helper: Help

  Returns number

longestOptionTermLength

• longestOptionTermLength(cmd: Command, helper: Help): number

  Get the longest option term length.

  Parameters

  • cmd: Command
  • helper: Help

  Returns number

longestSubcommandTermLength

• longestSubcommandTermLength(cmd: Command, helper: Help): number

  Get the longest command term length.

  Parameters

  • cmd: Command
  • helper: Help

  Returns number

optionDescription

• optionDescription(option: Option): string

  Get the option description to show in the list of options.

  Parameters

  • option: Option

  Returns string

optionTerm

• optionTerm(option: Option): string

  Get the option term to show in the list of options.

  Parameters

  • option: Option

  Returns string

padWidth

• padWidth(cmd: Command, helper: Help): number

  Calculate the pad width from the maximum term length.

  Parameters

  • cmd: Command
  • helper: Help

  Returns number

preformatted

• preformatted(str: string): boolean

  Detect manually wrapped and indented strings by checking for line break followed by whitespace.

  Parameters

  • str: string

  Returns boolean

prepareContext

• prepareContext(
      contextOptions: {
          error?: boolean;
          helpWidth?: number;
          outputHasColors?: boolean;
      },
  ): void

  Parameters

  • contextOptions: { error?: boolean; helpWidth?: number; outputHasColors?: boolean }

  Returns void

styleArgumentDescription

• styleArgumentDescription(str: string): string

  Parameters

  • str: string

  Returns string

styleArgumentTerm

• styleArgumentTerm(str: string): string

  Parameters

  • str: string

  Returns string

styleArgumentText

• styleArgumentText(str: string): string

  Base style used in terms and usage for arguments.

  Parameters

  • str: string

  Returns string

styleCommandDescription

• styleCommandDescription(str: string): string

  Parameters

  • str: string

  Returns string

styleCommandText

• styleCommandText(str: string): string

  Style for command name in usage string.

  Parameters

  • str: string

  Returns string

styleDescriptionText

• styleDescriptionText(str: string): string

  Base style used by descriptions.

  Parameters

  • str: string

  Returns string

styleOptionDescription

• styleOptionDescription(str: string): string

  Parameters

  • str: string

  Returns string

styleOptionTerm

• styleOptionTerm(str: string): string

  Parameters

  • str: string

  Returns string

styleOptionText

• styleOptionText(str: string): string

  Base style used in terms and usage for options.

  Parameters

  • str: string

  Returns string

styleSubcommandDescription

• styleSubcommandDescription(str: string): string

  Parameters

  • str: string

  Returns string

styleSubcommandTerm

• styleSubcommandTerm(str: string): string

  Parameters

  • str: string

  Returns string

styleSubcommandText

• styleSubcommandText(str: string): string

  Base style used in terms and usage for subcommands.

  Parameters

  • str: string

  Returns string

styleTitle

• styleTitle(title: string): string

  Style the titles. Called with 'Usage:', 'Options:', etc.

  Parameters

  • title: string

  Returns string

styleUsage

• styleUsage(str: string): string

  Usage:

  Parameters

  • str: string

  Returns string

subcommandDescription

• subcommandDescription(cmd: Command): string

  Get the command summary to show in the list of subcommands.

  Parameters

  • cmd: Command

  Returns string

subcommandTerm

• subcommandTerm(cmd: Command): string

  Get the command term to show in the list of subcommands.

  Parameters

  • cmd: Command

  Returns string

visibleArguments

• visibleArguments(cmd: Command): Argument[]

  Get an array of the arguments which have descriptions.

  Parameters

  • cmd: Command

  Returns Argument[]

visibleCommands

• visibleCommands(cmd: Command): Command[]

  Get an array of the visible subcommands. Includes a placeholder for the implicit help command, if there is one.

  Parameters

  • cmd: Command

  Returns Command[]

visibleGlobalOptions

• visibleGlobalOptions(cmd: Command): Option[]

  Get an array of the visible global options. (Not including help.)

  Parameters

  • cmd: Command

  Returns Option[]

visibleOptions

• visibleOptions(cmd: Command): Option[]

  Get an array of the visible options. Includes a placeholder for the implicit help option, if there is one.

  Parameters

  • cmd: Command

  Returns Option[]