Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions lib/src/docs/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,32 @@ arg "[default]" help="Arg with default value" default="default value"
");
}

#[test]
fn test_render_help_with_negated_flag() {
let spec = crate::spec! { r#"
bin "testcli"
flag "--compress" negate="--no-compress" default=#true help="Compress output"
flag "--verbose" help="Verbose output"
"# }
.unwrap();

assert_snapshot!(render_help(&spec, &spec.cmd, false), @r"
Usage: testcli [--compress] [--verbose]

Flags:
--compress / --no-compress Compress output
--verbose Verbose output
");

assert_snapshot!(render_help(&spec, &spec.cmd, true), @r"
Usage: testcli [--compress] [--verbose]

Flags:
--compress / --no-compress Compress output
--verbose Verbose output
");
}

#[test]
fn test_render_help_with_before_after_help() {
let spec = crate::spec! { r#"
Expand Down
4 changes: 2 additions & 2 deletions lib/src/docs/cli/templates/spec_template_long.tera
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ Arguments:
Flags:
{%- for flag in cmd.flags %}
{%- if flag.help_rendered %}
{{ flag.usage | ljust(width=flag.usage_col_width) }} {{ flag.help_rendered }}
{{ flag.display_usage | ljust(width=flag.usage_col_width) }} {{ flag.help_rendered }}
{%- if flag.help_is_multiline %}

{%- endif %}
{%- else %}
{{ flag.usage | trim }}
{{ flag.display_usage | trim }}
{%- if flag.aliases %} [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}
{%- set help = flag.help_long | default(value=flag.help | default(value='')) %}
{%- if help %}
Expand Down
2 changes: 1 addition & 1 deletion lib/src/docs/cli/templates/spec_template_short.tera
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Arguments:

Flags:
{%- for flag in cmd.flags %}
{{ flag.usage | trim }}
{{ flag.display_usage | trim }}
{%- if flag.aliases %} [aliases: {{ flag.aliases | join(sep=", ") }}]{% endif %}
{%- if flag.help %} {{ flag.help }}{%- endif %}
{%- if flag.arg.choices and flag.arg.choices.choices %} [{{ flag.arg.choices.choices | join(sep=", ") }}]{%- endif %}
Expand Down
17 changes: 10 additions & 7 deletions lib/src/docs/models.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ pub struct SpecCommand {
pub struct SpecFlag {
pub name: String,
pub usage: String,
pub display_usage: String,
pub help: Option<String>,
pub help_long: Option<String>,
pub help_md: Option<String>,
Expand Down Expand Up @@ -178,13 +179,11 @@ impl From<&crate::SpecCommand> for SpecCommand {
.collect();

// Calculate layout for flags
let flags_usage_col_width = max_usage_width(cmd.flags.iter().map(|f| f.usage.as_str()));
let flags: Vec<SpecFlag> = cmd
.flags
.iter()
.map(|flag| {
let mut spec_flag = SpecFlag::from(flag);

let flags: Vec<SpecFlag> = cmd.flags.iter().map(SpecFlag::from).collect();
let flags_usage_col_width = max_usage_width(flags.iter().map(|f| f.display_usage.as_str()));
let flags: Vec<SpecFlag> = flags
.into_iter()
.map(|mut spec_flag| {
// Get help text (prefer help_long over help)
let help_text = spec_flag.help_long.as_deref().or(spec_flag.help.as_deref());

Expand Down Expand Up @@ -241,6 +240,10 @@ impl From<&crate::SpecFlag> for SpecFlag {
Self {
name: flag.name.clone(),
usage: flag.usage.clone(),
display_usage: flag.negate.as_ref().map_or_else(
|| flag.usage.trim().to_string(),
|negate| format!("{} / {}", flag.usage.trim(), negate.trim()),
),
help: flag.help.clone(),
help_long: flag.help_long.clone(),
help_md: flag.help_md.clone(),
Expand Down