@nomiclabs/buidler > HelpPrinter

Class: HelpPrinter

Hierarchy

HelpPrinter

Index

Constructors

Methods


Constructors

constructor

new HelpPrinter(_programName: string, _executableName: string, _version: string, _buidlerParamDefinitions: BuidlerParamDefinitions, _tasks: TasksMap): HelpPrinter

Defined in internal/cli/HelpPrinter.ts:11

Parameters:

Name Type
_programName string
_executableName string
_version string
_buidlerParamDefinitions BuidlerParamDefinitions
_tasks TasksMap

Returns: HelpPrinter


Methods

_getParamValueDescription

_getParamValueDescription<T>(paramDefinition: ParamDefinition<T>): string

Defined in internal/cli/HelpPrinter.ts:108

Type parameters:

T

Parameters:

Name Type
paramDefinition ParamDefinition<T>

Returns: string


_getParamsList

_getParamsList(paramDefinitions: ParamDefinitionsMap): string

Defined in internal/cli/HelpPrinter.ts:112

Parameters:

Name Type
paramDefinitions ParamDefinitionsMap

Returns: string


_getPositionalParamsList

_getPositionalParamsList(positionalParamDefinitions: Array<ParamDefinition<any>>): string

Defined in internal/cli/HelpPrinter.ts:138

Parameters:

Name Type
positionalParamDefinitions Array<ParamDefinition<any>>

Returns: string


_printParamDetails

_printParamDetails(paramDefinitions: ParamDefinitionsMap): void

Defined in internal/cli/HelpPrinter.ts:164

Parameters:

Name Type
paramDefinitions ParamDefinitionsMap

Returns: void


_printPositionalParamDetails

_printPositionalParamDetails(positionalParamDefinitions: Array<ParamDefinition<any>>): void

Defined in internal/cli/HelpPrinter.ts:194

Parameters:

Name Type
positionalParamDefinitions Array<ParamDefinition<any>>

Returns: void


printGlobalHelp

printGlobalHelp(includeInternalTasks?: boolean): void

Defined in internal/cli/HelpPrinter.ts:20

Parameters:

Name Type Default value
Default value includeInternalTasks boolean false

Returns: void


printTaskHelp

printTaskHelp(taskName: string): void

Defined in internal/cli/HelpPrinter.ts:61

Parameters:

Name Type
taskName string

Returns: void