HelpTheme
Semantic styling roles for help output.
Roles that appear inside wrap-eligible description text (defaultValue, annotation, deprecated) should stick to foreground colors and dim — a styled span may cross a soft-wrap boundary, and while color/dim carry invisibly across the continuation indent, underline/inverse/background styles would visibly paint it.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/help/theme.ts - Source link:
src/core/help/theme.ts:27
Signatures
interface HelpTheme {}Members
Properties
annotation
Metadata annotations: [env: X], [config: a.b], [prompt], [required], (default).
annotation: Formatter;arg
Positional arg tokens: <file>, [out]....
arg: Formatter;command
Command names in Commands: tables.
command: Formatter;defaultValue
Default-value annotations: (default: 8080).
defaultValue: Formatter;deprecated
Deprecation labels: [deprecated], [deprecated: use --x].
deprecated: Formatter;examplePrompt
The $ prompt marker in Examples:.
examplePrompt: Formatter;flag
Flag forms in the flags table: -f, --force.
flag: Formatter;headerName
Program name in the root-help header.
headerName: Formatter;headerVersion
Version (vX.Y.Z) in the root-help header.
headerVersion: Formatter;placeholder
Grammar tokens: <string>, <command>, [flags], value hints.
placeholder: Formatter;sectionTitle
Section headings: Usage:, Arguments:, Flags:, Commands:, Examples:, Global options:.
sectionTitle: Formatter;usageBin
Binary / command path in the usage line.
usageBin: Formatter;