Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: fix(complete): escaping in zsh completion #3713

Closed
wants to merge 1 commit into from
+27 −5
Closed

WIP: fix(complete): escaping in zsh completion #3713

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 27 additions & 5 deletions clap_complete/src/shells/zsh.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ fn value_completion(arg: &Arg) -> Option<String> {
} else {
Some(format!(
r#"{name}\:"{tooltip}""#,
name = escape_value(value.get_name()),
name = escape_value(value.get_name(), true),
tooltip = value.get_help().map(escape_help).unwrap_or_default()
))
}
Expand All @@ -388,7 +388,8 @@ fn value_completion(arg: &Arg) -> Option<String> {
values
.iter()
.filter(|pv| !pv.is_hide_set())
.map(PossibleValue::get_name)
.map(|pv| escape_value(pv.get_name(), false))
// TODO(pseyfert): review, merge conflict Some(format!("{}", escape_value(value.get_name(), false)
.collect::<Vec<_>>()
.join(" ")
))
Expand Down Expand Up @@ -431,13 +432,34 @@ fn escape_help(string: &str) -> String {
}

/// Escape value string inside single quotes and parentheses
fn escape_value(string: &str) -> String {
fn escape_value(string: &str, with_tooltip: bool) -> String {
string
.replace('\\', "\\\\")
.replace('\'', "'\\''")
// .replace('\\', "\\\\")
// .replace('\\', "\\\\\\\\") // ':: :((\\\\\:"some descr"))' \
.replace('\\', if with_tooltip {"\\\\\\\\"} else {"\\\\"})
.replace('\'', "'\\\\\\''")
.replace('(', "\\(")
.replace(')', "\\)")
.replace('[', "\\[")
.replace(']', "\\]")
.replace('"', "\\\"")
.replace(' ', "\\ ")
.replace('`', "\\`")
.replace('&', "\\&")
.replace('#', "\\#")
.replace('{', "\\{") // only needed w/o tooltip
.replace('}', "\\}") // only needed w/o tooltip
.replace('$', "\\$") // only needed w/o tooltip
.replace('|', "\\|")
.replace('~', "\\~")
.replace('?', "\\?")
.replace('^', "\\^")
.replace('*', "\\*")
.replace(';', "\\;")
.replace('<', "\\<")
.replace('>', "\\>")
.replace('=', "\\=") // ':: :((\=\:"some descr"))' \
.replace(':', if with_tooltip {"\\\\\\:"} else {":"}) // ':: :((\\\:\:"some descr"))' \
}

fn write_opts_of(p: &Command, p_global: Option<&Command>) -> String {
Expand Down