pretty-exec — Reference

Index

Namespaces

ParsingResult

Interfaces

Variables

Functions

Object literals

SPAWN_OPTIONS

Variables

Const DEFAULT_ARGUMENT_STYLING_FUNC

DEFAULT_ARGUMENT_STYLING_FUNC: StylingFunc = chalk

Const DEFAULT_COLOR_SCHEMES

DEFAULT_COLOR_SCHEMES: ColorSchemes

Const DEFAULT_COMMAND_STYLING_FUNC

DEFAULT_COMMAND_STYLING_FUNC: StylingFunc = chalk.green

Const DEFAULT_FLAG_STYLING_FUNC

DEFAULT_FLAG_STYLING_FUNC: StylingFunc = chalk.red

Const DEFAULT_OPTION_KEY_STYLING_FUNC

DEFAULT_OPTION_KEY_STYLING_FUNC: StylingFunc = chalk.red

Const DEFAULT_OPTION_VALUE_STYLING_FUNC

DEFAULT_OPTION_VALUE_STYLING_FUNC: StylingFunc = chalk

Const DEFAULT_PREFIX

DEFAULT_PREFIX: ["$"] = ['$'] as const

Const DEFAULT_PREFIX_STYLING_FUNC

DEFAULT_PREFIX_STYLING_FUNC: StylingFunc = chalk.dim

Functions

createPrettyExec

createPrettyExec<Return>(options: CreateOptions<Return>): PrettyExec<Return>

- Defined in lib/pretty-exec.ts:55
Type parameters
- Return
Parameters
- options: CreateOptions<Return>
Returns PrettyExec<Return>

escape

escape(...args: string[]): any

- Defined in lib/pretty-exec.ts:51
Parameters
- Rest ...args: string[]
Returns any

main

main<Status>(options: CliExecEnv<Status>): Status | -1

- Defined in lib/cli.ts:22
Type parameters
- Status
Parameters
- options: CliExecEnv<Status>
Returns Status | -1

parseCommandArguments

parseCommandArguments(args: Iterable<string>): ParsingResult[]

- Defined in lib/parse-command-arguments.ts:47
Parameters
- args: Iterable<string>
Returns ParsingResult[]

parseSingleCommandArgument

parseSingleCommandArgument(text: string): ParsingResult

- Defined in lib/parse-command-arguments.ts:33
Parameters
- text: string
Returns ParsingResult

Object literals

Const SPAWN_OPTIONS

SPAWN_OPTIONS: object

stdio

stdio: "inherit" = "inherit"

Generated using TypeDoc