Skip to main content

Interface: FormattingConfiguration

Configuration for controlling how printed documentation is formatted.

Properties​

caseStyle​

readonly caseStyle: DisplayCaseStyle

Case style configuration for displaying route and flag names. Cannot be convert-camel-to-kebab if ScannerConfiguration.caseStyle is original.

Defined in​

packages/core/src/parameter/formatting.ts:29

onlyRequiredInUsageLine​

readonly onlyRequiredInUsageLine: boolean

Controls whether or not to include optional flags and positional parameters in the usage line. If enabled, all parameters that are optional at runtime (including parameters with defaults) will be hidden.

Defined in​

packages/core/src/parameter/formatting.ts:24

useAliasInUsageLine​

readonly useAliasInUsageLine: boolean

Controls whether or not to include alias of flags in the usage line. Only replaces name with alias when a single alias exists.

Defined in​

packages/core/src/parameter/formatting.ts:19