Skip to content

Commit f2c4e6e

Browse files
epageepage
authored
Merge pull request #5359 from poliorcetics/ab/push-szymvyzpmnqx
fix(clap_complete_nushell): correctly handle commands whose short description is more than one line
2 parents 8a7a13a + e782775 commit f2c4e6e

File tree

26 files changed

+90
-83
lines changed

26 files changed

+90
-83
lines changed

‎clap_complete/src/shells/elvish.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ fn escape_string(string: &str) -> String {
5757
string.replace('\'', "''")
5858
}
5959

60-
fn get_tooltip<T: ToString>(help: Option<&StyledStr>, data: T) -> String {
60+
fn escape_help<T: ToString>(help: Option<&StyledStr>, data: T) -> String {
6161
match help {
62-
Some(help) => escape_string(&help.to_string()),
62+
Some(help) => escape_string(&help.to_string().replace('\n', " ")),
6363
_ => data.to_string(),
6464
}
6565
}
@@ -78,15 +78,15 @@ fn generate_inner(p: &Command, previous_command_name: &str) -> String {
7878

7979
for option in p.get_opts() {
8080
if let Some(shorts) = option.get_short_and_visible_aliases() {
81-
let tooltip = get_tooltip(option.get_help(), shorts[0]);
81+
let tooltip = escape_help(option.get_help(), shorts[0]);
8282
for short in shorts {
8383
completions.push_str(&preamble);
8484
completions.push_str(format!("-{short} '{tooltip}'").as_str());
8585
}
8686
}
8787

8888
if let Some(longs) = option.get_long_and_visible_aliases() {
89-
let tooltip = get_tooltip(option.get_help(), longs[0]);
89+
let tooltip = escape_help(option.get_help(), longs[0]);
9090
for long in longs {
9191
completions.push_str(&preamble);
9292
completions.push_str(format!("--{long} '{tooltip}'").as_str());
@@ -96,15 +96,15 @@ fn generate_inner(p: &Command, previous_command_name: &str) -> String {
9696

9797
for flag in utils::flags(p) {
9898
if let Some(shorts) = flag.get_short_and_visible_aliases() {
99-
let tooltip = get_tooltip(flag.get_help(), shorts[0]);
99+
let tooltip = escape_help(flag.get_help(), shorts[0]);
100100
for short in shorts {
101101
completions.push_str(&preamble);
102102
completions.push_str(format!("-{short} '{tooltip}'").as_str());
103103
}
104104
}
105105

106106
if let Some(longs) = flag.get_long_and_visible_aliases() {
107-
let tooltip = get_tooltip(flag.get_help(), longs[0]);
107+
let tooltip = escape_help(flag.get_help(), longs[0]);
108108
for long in longs {
109109
completions.push_str(&preamble);
110110
completions.push_str(format!("--{long} '{tooltip}'").as_str());
@@ -114,7 +114,7 @@ fn generate_inner(p: &Command, previous_command_name: &str) -> String {
114114

115115
for subcommand in p.get_subcommands() {
116116
let data = &subcommand.get_name();
117-
let tooltip = get_tooltip(subcommand.get_about(), data);
117+
let tooltip = escape_help(subcommand.get_about(), data);
118118

119119
completions.push_str(&preamble);
120120
completions.push_str(format!("{data} '{tooltip}'").as_str());

‎clap_complete/src/shells/fish.rs

+8-6
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ fn escape_string(string: &str, escape_comma: bool) -> String {
3636
}
3737
}
3838

39+
fn escape_help(help: &clap::builder::StyledStr) -> String {
40+
escape_string(&help.to_string().replace('\n', " "), false)
41+
}
42+
3943
fn gen_fish_inner(
4044
root_command: &str,
4145
parent_commands: &[&str],
@@ -98,8 +102,7 @@ fn gen_fish_inner(
98102
}
99103

100104
if let Some(data) = option.get_help() {
101-
template
102-
.push_str(format!(" -d '{}'", escape_string(&data.to_string(), false)).as_str());
105+
template.push_str(&format!(" -d '{}'", escape_help(data)));
103106
}
104107

105108
template.push_str(value_completion(option).as_str());
@@ -124,8 +127,7 @@ fn gen_fish_inner(
124127
}
125128

126129
if let Some(data) = flag.get_help() {
127-
template
128-
.push_str(format!(" -d '{}'", escape_string(&data.to_string(), false)).as_str());
130+
template.push_str(&format!(" -d '{}'", escape_help(data)));
129131
}
130132

131133
buffer.push_str(template.as_str());
@@ -139,7 +141,7 @@ fn gen_fish_inner(
139141
template.push_str(format!(" -a \"{}\"", &subcommand.get_name()).as_str());
140142

141143
if let Some(data) = subcommand.get_about() {
142-
template.push_str(format!(" -d '{}'", escape_string(&data.to_string(), false)).as_str())
144+
template.push_str(format!(" -d '{}'", escape_help(data)).as_str())
143145
}
144146

145147
buffer.push_str(template.as_str());
@@ -173,7 +175,7 @@ fn value_completion(option: &Arg) -> String {
173175
Some(format!(
174176
"{}\t'{}'",
175177
escape_string(value.get_name(), true).as_str(),
176-
escape_string(&value.get_help().unwrap_or_default().to_string(), false)
178+
escape_help(value.get_help().unwrap_or_default())
177179
))
178180
})
179181
.collect::<Vec<_>>()

‎clap_complete/src/shells/powershell.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ fn escape_string(string: &str) -> String {
6262
string.replace('\'', "''")
6363
}
6464

65-
fn get_tooltip<T: ToString>(help: Option<&StyledStr>, data: T) -> String {
65+
fn escape_help<T: ToString>(help: Option<&StyledStr>, data: T) -> String {
6666
match help {
67-
Some(help) => escape_string(&help.to_string()),
67+
Some(help) => escape_string(&help.to_string().replace('\n', " ")),
6868
_ => data.to_string(),
6969
}
7070
}
@@ -91,7 +91,7 @@ fn generate_inner(p: &Command, previous_command_name: &str) -> String {
9191

9292
for subcommand in p.get_subcommands() {
9393
let data = &subcommand.get_name();
94-
let tooltip = get_tooltip(subcommand.get_about(), data);
94+
let tooltip = escape_help(subcommand.get_about(), data);
9595

9696
completions.push_str(&preamble);
9797
completions.push_str(
@@ -120,7 +120,7 @@ fn generate_aliases(completions: &mut String, preamble: &String, arg: &Arg) {
120120
use std::fmt::Write as _;
121121

122122
if let Some(aliases) = arg.get_short_and_visible_aliases() {
123-
let tooltip = get_tooltip(arg.get_help(), aliases[0]);
123+
let tooltip = escape_help(arg.get_help(), aliases[0]);
124124
for alias in aliases {
125125
let _ = write!(
126126
completions,
@@ -131,7 +131,7 @@ fn generate_aliases(completions: &mut String, preamble: &String, arg: &Arg) {
131131
}
132132
}
133133
if let Some(aliases) = arg.get_long_and_visible_aliases() {
134-
let tooltip = get_tooltip(arg.get_help(), aliases[0]);
134+
let tooltip = escape_help(arg.get_help(), aliases[0]);
135135
for alias in aliases {
136136
let _ = write!(
137137
completions,

‎clap_complete/src/shells/zsh.rs

+1
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,7 @@ fn escape_help(string: &str) -> String {
429429
.replace(':', "\\:")
430430
.replace('$', "\\$")
431431
.replace('`', "\\`")
432+
.replace('\n', " ")
432433
}
433434

434435
/// Escape value string inside single quotes and parentheses

‎clap_complete/tests/snapshots/basic.elvish

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ set edit:completion:arg-completer[my-app] = {|@words|
2222
cand -v 'v'
2323
cand -h 'Print help'
2424
cand --help 'Print help'
25-
cand test 'Subcommand'
25+
cand test 'Subcommand with a second line'
2626
cand help 'Print this message or the help of the given subcommand(s)'
2727
}
2828
&'my-app;test'= {
@@ -32,7 +32,7 @@ set edit:completion:arg-completer[my-app] = {|@words|
3232
cand --help 'Print help'
3333
}
3434
&'my-app;help'= {
35-
cand test 'Subcommand'
35+
cand test 'Subcommand with a second line'
3636
cand help 'Print this message or the help of the given subcommand(s)'
3737
}
3838
&'my-app;help;test'= {

‎clap_complete/tests/snapshots/basic.fish

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
complete -c my-app -n "__fish_use_subcommand" -s c
22
complete -c my-app -n "__fish_use_subcommand" -s v
33
complete -c my-app -n "__fish_use_subcommand" -s h -l help -d 'Print help'
4-
complete -c my-app -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand'
4+
complete -c my-app -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand with a second line'
55
complete -c my-app -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
66
complete -c my-app -n "__fish_seen_subcommand_from test" -s d
77
complete -c my-app -n "__fish_seen_subcommand_from test" -s c
88
complete -c my-app -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help'
9-
complete -c my-app -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand'
9+
complete -c my-app -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand with a second line'
1010
complete -c my-app -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'

‎clap_complete/tests/snapshots/basic.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Register-ArgumentCompleter -Native -CommandName 'my-app' -ScriptBlock {
2525
[CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'v')
2626
[CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')
2727
[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help')
28-
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
28+
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand with a second line')
2929
[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
3030
break
3131
}
@@ -37,7 +37,7 @@ Register-ArgumentCompleter -Native -CommandName 'my-app' -ScriptBlock {
3737
break
3838
}
3939
'my-app;help' {
40-
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
40+
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand with a second line')
4141
[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
4242
break
4343
}

‎clap_complete/tests/snapshots/basic.zsh

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ esac
6868
(( $+functions[_my-app_commands] )) ||
6969
_my-app_commands() {
7070
local commands; commands=(
71-
'test:Subcommand' \
71+
'test:Subcommand with a second line' \
7272
'help:Print this message or the help of the given subcommand(s)' \
7373
)
7474
_describe -t commands 'my-app commands' commands "$@"
7575
}
7676
(( $+functions[_my-app__help_commands] )) ||
7777
_my-app__help_commands() {
7878
local commands; commands=(
79-
'test:Subcommand' \
79+
'test:Subcommand with a second line' \
8080
'help:Print this message or the help of the given subcommand(s)' \
8181
)
8282
_describe -t commands 'my-app help commands' commands "$@"

‎clap_complete/tests/snapshots/custom_bin_name.elvish

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ set edit:completion:arg-completer[bin-name] = {|@words|
2222
cand -v 'v'
2323
cand -h 'Print help'
2424
cand --help 'Print help'
25-
cand test 'Subcommand'
25+
cand test 'Subcommand with a second line'
2626
cand help 'Print this message or the help of the given subcommand(s)'
2727
}
2828
&'bin-name;test'= {
@@ -32,7 +32,7 @@ set edit:completion:arg-completer[bin-name] = {|@words|
3232
cand --help 'Print help'
3333
}
3434
&'bin-name;help'= {
35-
cand test 'Subcommand'
35+
cand test 'Subcommand with a second line'
3636
cand help 'Print this message or the help of the given subcommand(s)'
3737
}
3838
&'bin-name;help;test'= {

‎clap_complete/tests/snapshots/custom_bin_name.fish

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
complete -c bin-name -n "__fish_use_subcommand" -s c
22
complete -c bin-name -n "__fish_use_subcommand" -s v
33
complete -c bin-name -n "__fish_use_subcommand" -s h -l help -d 'Print help'
4-
complete -c bin-name -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand'
4+
complete -c bin-name -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand with a second line'
55
complete -c bin-name -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
66
complete -c bin-name -n "__fish_seen_subcommand_from test" -s d
77
complete -c bin-name -n "__fish_seen_subcommand_from test" -s c
88
complete -c bin-name -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help'
9-
complete -c bin-name -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand'
9+
complete -c bin-name -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand with a second line'
1010
complete -c bin-name -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'

‎clap_complete/tests/snapshots/custom_bin_name.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Register-ArgumentCompleter -Native -CommandName 'bin-name' -ScriptBlock {
2525
[CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'v')
2626
[CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')
2727
[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help')
28-
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
28+
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand with a second line')
2929
[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
3030
break
3131
}
@@ -37,7 +37,7 @@ Register-ArgumentCompleter -Native -CommandName 'bin-name' -ScriptBlock {
3737
break
3838
}
3939
'bin-name;help' {
40-
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
40+
[CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand with a second line')
4141
[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
4242
break
4343
}

‎clap_complete/tests/snapshots/custom_bin_name.zsh

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ esac
6868
(( $+functions[_bin-name_commands] )) ||
6969
_bin-name_commands() {
7070
local commands; commands=(
71-
'test:Subcommand' \
71+
'test:Subcommand with a second line' \
7272
'help:Print this message or the help of the given subcommand(s)' \
7373
)
7474
_describe -t commands 'bin-name commands' commands "$@"
7575
}
7676
(( $+functions[_bin-name__help_commands] )) ||
7777
_bin-name__help_commands() {
7878
local commands; commands=(
79-
'test:Subcommand' \
79+
'test:Subcommand with a second line' \
8080
'help:Print this message or the help of the given subcommand(s)' \
8181
)
8282
_describe -t commands 'bin-name help commands' commands "$@"

‎clap_complete/tests/snapshots/home/static/exhaustive/elvish/elvish/rc.elv

+3-6
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,7 @@ set edit:completion:arg-completer[exhaustive] = {|@words|
6666
cand cmd-backslash 'Avoid ''\n'''
6767
cand cmd-brackets 'List packages [filter]'
6868
cand cmd-expansions 'Execute the shell command with $SHELL'
69-
cand escape-help '\tab "''
70-
New Line'
69+
cand escape-help '\tab "'' New Line'
7170
cand help 'Print this message or the help of the given subcommand(s)'
7271
}
7372
&'exhaustive;quote;cmd-single-quotes'= {
@@ -126,8 +125,7 @@ New Line'
126125
cand cmd-backslash 'Avoid ''\n'''
127126
cand cmd-brackets 'List packages [filter]'
128127
cand cmd-expansions 'Execute the shell command with $SHELL'
129-
cand escape-help '\tab "''
130-
New Line'
128+
cand escape-help '\tab "'' New Line'
131129
cand help 'Print this message or the help of the given subcommand(s)'
132130
}
133131
&'exhaustive;quote;help;cmd-single-quotes'= {
@@ -269,8 +267,7 @@ New Line'
269267
cand cmd-backslash 'Avoid ''\n'''
270268
cand cmd-brackets 'List packages [filter]'
271269
cand cmd-expansions 'Execute the shell command with $SHELL'
272-
cand escape-help '\tab "''
273-
New Line'
270+
cand escape-help '\tab "'' New Line'
274271
}
275272
&'exhaustive;help;quote;cmd-single-quotes'= {
276273
}

0 commit comments

Comments
 (0)