Class StyledHelp

Hierarchy

Help
- StyledHelp

Index

Constructors

Methods

formatHelp styleTitle styleOptionText styleArgumentText styleSubcommandText

Constructors

constructor

new StyledHelp(): StyledHelp
Returns StyledHelp
Inherited from Help.constructor
- Defined in node_modules/commander/typings/index.d.ts:218

Methods

formatHelp

formatHelp(cmd: Command, helper: Help): string
Generate the built-in help text.
Parameters
- cmd: Command
- helper: Help
Returns string
Overrides Help.formatHelp
- Defined in src/utils/help.ts:6

styleTitle

styleTitle(str: string): string
Style the titles. Called with 'Usage:', 'Options:', etc.
Parameters
- str: string
Returns string
Overrides Help.styleTitle
- Defined in src/utils/help.ts:19

styleOptionText

styleOptionText(str: string): string
Base style used in terms and usage for options.
Parameters
- str: string
Returns string
Overrides Help.styleOptionText
- Defined in src/utils/help.ts:23

styleArgumentText

styleArgumentText(str: string): string
Base style used in terms and usage for arguments.
Parameters
- str: string
Returns string
Overrides Help.styleArgumentText
- Defined in src/utils/help.ts:27

styleSubcommandText

styleSubcommandText(str: string): string
Base style used in terms and usage for subcommands.
Parameters
- str: string
Returns string
Overrides Help.styleSubcommandText
- Defined in src/utils/help.ts:31