Skip to main content

Interface: DocumentationConfiguration

Configuration for controlling the content of the printed documentation.

Properties​

alwaysShowHelpAllFlag​

readonly alwaysShowHelpAllFlag: boolean

In addition to the --help flag, there is a --helpAll/--help-all flag that shows all documentation including entries for hidden commands/arguments. The --helpAll flag cannot be functionally disabled, but it is hidden when listing the built-in flags by default. Setting this option to true forces the output to always include this flag in the list of built-in flags.

Defaults to false.

Defined in​

packages/core/src/config.ts:129

caseStyle​

readonly caseStyle: DisplayCaseStyle

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

Default value is derived from value for ScannerConfiguration.caseStyle:

  • Defaults to original for original.
  • Defaults to convert-camel-to-kebab for allow-kebab-for-camel.

Defined in​

packages/core/src/config.ts:152

disableAnsiColor​

readonly disableAnsiColor: boolean

By default, if the color depth of the stdout stream is greater than 4, ANSI terminal colors will be used. If this value is true, disables all ANSI terminal color output.

Defaults to false.

Defined in​

packages/core/src/config.ts:159

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.

Defaults to false.

Defined in​

packages/core/src/config.ts:143

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.

Defaults to false.

Defined in​

packages/core/src/config.ts:136