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

Improve bash completion with compopt #5240

Merged
merged 4 commits into from
Jan 22, 2024
Merged

Improve bash completion with compopt #5240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62a5ace
test(complete): Verify some variants of ValueHint
sudotac Dec 10, 2023
3a222de
fix(complete): Fix path completion in bash
sudotac Dec 3, 2023
e25b1ab
feat(complete): Add DirPath support in bash
sudotac Dec 3, 2023
13a7980
fix(complete): Suppress a useless space completion
sudotac Dec 3, 2023
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
55 changes: 39 additions & 16 deletions clap_complete/src/shells/bash.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,29 +168,50 @@ fn option_details_for_path(cmd: &Command, path: &str) -> String {
let mut opts = vec![String::new()];

for o in p.get_opts() {
let compopt = match o.get_value_hint() {
ValueHint::FilePath => Some("compopt -o filenames"),
ValueHint::DirPath => Some("compopt -o plusdirs"),
ValueHint::Other => Some("compopt -o nospace"),
_ => None,
};

if let Some(longs) = o.get_long_and_visible_aliases() {
opts.extend(longs.iter().map(|long| {
format!(
"--{})
COMPREPLY=({})
return 0
;;",
long,
vals_for(o)
)
let mut v = vec![
format!("--{})", long),
format!("COMPREPLY=({})", vals_for(o)),
];

if let Some(copt) = compopt {
v.extend([
r#"if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then"#.to_string(),
format!(" {}", copt),
"fi".to_string(),
]);
}

v.extend(["return 0", ";;"].iter().map(|s| s.to_string()));
v.join("\n ")
}));
}

if let Some(shorts) = o.get_short_and_visible_aliases() {
opts.extend(shorts.iter().map(|short| {
format!(
"-{})
COMPREPLY=({})
return 0
;;",
short,
vals_for(o)
)
let mut v = vec![
format!("-{})", short),
format!("COMPREPLY=({})", vals_for(o)),
];

if let Some(copt) = compopt {
v.extend([
r#"if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then"#.to_string(),
format!(" {}", copt),
"fi".to_string(),
]);
}

v.extend(["return 0", ";;"].iter().map(|s| s.to_string()));
v.join("\n ")
}));
}
}
Expand All @@ -210,6 +231,8 @@ fn vals_for(o: &Arg) -> String {
.collect::<Vec<_>>()
.join(" ")
)
} else if o.get_value_hint() == ValueHint::DirPath {
String::from("") // should be empty to avoid duplicate candidates
} else if o.get_value_hint() == ValueHint::Other {
String::from("\"${cur}\"")
} else {
Expand Down
19 changes: 17 additions & 2 deletions clap_complete/tests/snapshots/home/static/exhaustive/bash/.bashrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,9 @@ _exhaustive() {
;;
--other)
COMPREPLY=("${cur}")
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o nospace
fi
return 0
;;
--path)
Expand All @@ -554,18 +557,30 @@ _exhaustive() {
;;
--file)
COMPREPLY=($(compgen -f "${cur}"))
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o filenames
fi
return 0
;;
-f)
COMPREPLY=($(compgen -f "${cur}"))
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o filenames
fi
return 0
;;
--dir)
COMPREPLY=($(compgen -f "${cur}"))
COMPREPLY=()
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o plusdirs
fi
return 0
;;
-d)
COMPREPLY=($(compgen -f "${cur}"))
COMPREPLY=()
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o plusdirs
fi
return 0
;;
--exe)
Expand Down
19 changes: 17 additions & 2 deletions clap_complete/tests/snapshots/value_hint.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ _my-app() {
;;
--other)
COMPREPLY=("${cur}")
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o nospace
fi
return 0
;;
--path)
Expand All @@ -47,18 +50,30 @@ _my-app() {
;;
--file)
COMPREPLY=($(compgen -f "${cur}"))
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o filenames
fi
return 0
;;
-f)
COMPREPLY=($(compgen -f "${cur}"))
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o filenames
fi
return 0
;;
--dir)
COMPREPLY=($(compgen -f "${cur}"))
COMPREPLY=()
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o plusdirs
fi
return 0
;;
-d)
COMPREPLY=($(compgen -f "${cur}"))
COMPREPLY=()
if [[ "${BASH_VERSINFO[0]}" -ge 4 ]]; then
compopt -o plusdirs
fi
return 0
;;
--exe)
Expand Down
52 changes: 52 additions & 0 deletions clap_complete/tests/testsuite/bash.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,58 @@ fn complete() {
-V --generate --version quote pacman alias complete "#;
let actual = runtime.complete(input, &term).unwrap();
snapbox::assert_eq(expected, actual);

// Issue 5239 (https://github.com/clap-rs/clap/issues/5239)
let input = "exhaustive hint --file test\t";
let expected = "exhaustive hint --file test % exhaustive hint --file tests/";
epage marked this conversation as resolved.
Show resolved Hide resolved
let actual = runtime.complete(input, &term).unwrap();
snapbox::assert_eq(expected, actual);

{
use std::fs::File;
use std::path::Path;

let testdir = snapbox::path::PathFixture::mutable_temp().unwrap();
let testdir_path = testdir.path().unwrap();

File::create(Path::new(testdir_path).join("a_file")).unwrap();
File::create(Path::new(testdir_path).join("b_file")).unwrap();
std::fs::create_dir(Path::new(testdir_path).join("c_dir")).unwrap();
std::fs::create_dir(Path::new(testdir_path).join("d_dir")).unwrap();

let input = format!(
"exhaustive hint --file {}/\t\t",
testdir_path.to_string_lossy()
);
let actual = runtime.complete(input.as_str(), &term).unwrap();
assert!(
actual.contains("a_file")
&& actual.contains("b_file")
&& actual.contains("c_dir")
&& actual.contains("d_dir"),
"Actual output:\n{}",
actual
);

let input = format!(
"exhaustive hint --dir {}/\t\t",
testdir_path.to_string_lossy()
);
let actual = runtime.complete(input.as_str(), &term).unwrap();
assert!(
!actual.contains("a_file")
&& !actual.contains("b_file")
&& actual.contains("c_dir")
&& actual.contains("d_dir"),
"Actual output:\n{}",
actual
);
}

let input = "exhaustive hint --other \t";
let expected = "exhaustive hint --other % exhaustive hint --other ";
let actual = runtime.complete(input, &term).unwrap();
snapbox::assert_eq(expected, actual);
}

#[test]
Expand Down
Loading