Struct DefaultHelpFormatter 

pub struct DefaultHelpFormatter;

Default help formatter — colored, aligned, English-only output.

Outputs English text to the terminal. If you need another language, implement HelpFormatter and supply it via CliBuilder::help_formatter(). Uses the colored crate for terminal output. Colours are applied automatically and disabled when the terminal does not support them.

Column widths are computed dynamically so that descriptions are aligned regardless of command or argument name lengths.

Example

use dynamic_cli::help::DefaultHelpFormatter;

let fmt = DefaultHelpFormatter::new();
// or equivalently:
let fmt = DefaultHelpFormatter::default();

Implementations

impl DefaultHelpFormatter

pub fn new() -> Self

Create a new DefaultHelpFormatter.

Trait Implementations

impl Debug for DefaultHelpFormatter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DefaultHelpFormatter

fn default() -> Self

Returns the “default value” for a type.

impl HelpFormatter for DefaultHelpFormatter

fn format_app(&self, config: &CommandsConfig) -> String

Format the application-level help (list of all commands).

Output structure

myapp 1.0.0

USAGE:
    <command> [arguments] [options]

COMMANDS:
    hello      Say hello to someone
    process    Process data files

The output is the same in CLI and REPL mode. How to ask for the help of one command differs between them, so the interface appends that line itself.

fn format_command(&self, config: &CommandsConfig, command: &str) -> String

Format help for a single command, looked up by name or alias.

Output structure

hello — Say hello to someone

USAGE:
    hello <name> [options]

ARGUMENTS:
    name    (string, required)  Name to greet

OPTIONS:
    -l, --loud    (bool)  Use uppercase

ALIASES:
    hi

If the command is not found, returns a message listing available commands.

fn format_directives(&self, directives: &[DirectiveDefinition]) -> String

Format the list of REPL directives, in the layout of the default trait implementation with colours.

Output structure

DIRECTIVES:
    :help [command]      Show the application help, or the help of a command [aliases: :h, :?]
    :load <path>         Run every line of a script file
    :quit                Save the session history and leave [aliases: :q]
    :exit                Leave without saving the session history