Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-14 06:42:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat(Completions): one can generate a basic fish completions script at compile time

Browse source 
The following completion would happen (using example 17_yaml.rs):

```
$ prog <tab>
help subcmd
```

```
$ prog -<tab><tab>
--help  -h                            (Prints help information)
--max-vals      (you can only supply a max of 3 values for me!)
--min-vals  (you must supply at least two values to satisfy me)
--mode                   (shows an option with specific values)
--mult-vals        (demos an option which has two named values)
--option  -o                (example option argument from yaml)
--version  -V                      (Prints version information)
-F                                         (demo flag argument)
```

```
$ prog --<tab><tab>
--help  -h                            (Prints help information)
--max-vals      (you can only supply a max of 3 values for me!)
--min-vals  (you must supply at least two values to satisfy me)
--mode                   (shows an option with specific values)
--mult-vals        (demos an option which has two named values)
--option  -o                (example option argument from yaml)
--version  -V                      (Prints version information)
```

```
$ prog --mode <tab>
emacs  (shows an option with specific values)  vi  (shows an option with specific values)
```

```
$ prog subcmd -<tab>
--help  -h        (Prints help information)  -B  (example subcommand option)
--version  -V  (Prints version information)
```

```
$ prog subcmd --<tab>
--help  (Prints help information)  --version  (Prints version information)
```

Close #578
This commit is contained in:
Chiu-Hsiang Hsu 2016-07-11 10:50:45 +08:00
parent 9605ea83aa
commit 1979d2f2f3
3 changed files with 133 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/app/parser.rs
View file

@ -39,7 +39,7 @@ pub struct Parser<'a, 'b>
pub long_list: Vec<&'b str>,
blacklist: Vec<&'b str>,
// A list of possible flags
flags: Vec<FlagBuilder<'a, 'b>>,
pub flags: Vec<FlagBuilder<'a, 'b>>,
// A list of possible options
pub opts: Vec<OptBuilder<'a, 'b>>,
// A list of positional arguments
@ -113,8 +113,12 @@ impl<'a, 'b> Parser<'a, 'b>
use std::error::Error;
let out_dir = PathBuf::from(od);
let suffix = match for_shell {
Shell::Bash => "_bash.sh",
Shell::Fish => ".fish",
};
let mut file = match File::create(out_dir.join(format!("{}_bash.sh", &*self.meta.bin_name.as_ref().unwrap()))) {
let mut file = match File::create(out_dir.join(format!("{}{}", &*self.meta.bin_name.as_ref().unwrap(), suffix))) {
Err(why) => panic!("couldn't create bash completion file: {}",
why.description()),
Ok(file) => file,

124
src/completions.rs
View file

@ -27,6 +27,7 @@ impl<'a, 'b> ComplGen<'a, 'b> {
pub fn generate<W: Write>(&self, for_shell: Shell, buf: &mut W) {
match for_shell {
Shell::Bash => self.gen_bash(buf),
Shell::Fish => self.gen_fish(buf),
}
}
@ -187,6 +188,32 @@ complete -F _{name} {name}
}
opts
}
fn gen_fish<W: Write>(&self, buf: &mut W) {
let command = self.p.meta.bin_name.as_ref().unwrap();
let subcommands: Vec<_> = get_all_subcommands(self.p);
let has_subcommands = subcommands.len() > 1;
// function to detect subcommand
let detect_subcommand_function = if has_subcommands {
format!(
r#"function __fish_{}_no_subcommand --description "Test if there isn't given a subcommand"
for i in (commandline -opc)
if contains -- $i {}
return 1
end
end
return 0
end
"#, command, subcommands.join(" "))
} else {
"".to_string()
};
let mut buffer = detect_subcommand_function;
gen_fish_inner(command, &self, vec![], &mut buffer, has_subcommands);
w!(buf, buffer.as_bytes());
}
}
pub fn get_all_subcommands(p: &Parser) -> Vec<String> {
@ -293,3 +320,100 @@ fn vals_for(o: &OptBuilder) -> String {
}
ret
}
fn gen_fish_inner(root_command: &String,
comp_gen: &ComplGen,
parent_cmds: Vec<&String>,
buffer: &mut String,
has_no_subcommand_fn: bool) {
// example :
//
// complete
// -c {command}
// -d "{description}"
// -s {short}
// -l {long}
// -a "{possible_arguments}"
// -r # if require parameter
// -f # don't use file completion
// -n "__fish_seen_subcommand_from install" # complete for subcommand "install"
let command = &comp_gen.p.meta.name;
let subcommands: Vec<_> = get_all_subcommands(comp_gen.p);
for option in &comp_gen.p.opts {
let mut template = format!("complete -c {}", root_command);
if !parent_cmds.is_empty() {
template.push_str(format!(" -n '__fish_seen_subcommand_from {}'",
command).as_str());
} else if has_no_subcommand_fn {
template.push_str(format!(" -n '__fish_{}_no_subcommand'",
comp_gen.p.meta.bin_name.as_ref().unwrap()).as_str());
}
if let Some(data) = option.short {
template.push_str(format!(" -s {}", data).as_str());
}
if let Some(data) = option.long {
template.push_str(format!(" -l {}", data).as_str());
}
if let Some(data) = option.help {
template.push_str(format!(" -d '{}'", data).as_str());
}
if let Some(ref data) = option.possible_vals {
template.push_str(format!(" -r -f -a '{}'", data.join(" ")).as_str());
}
buffer.push_str(template.as_str());
buffer.push_str("\n");
}
for flag in &comp_gen.p.flags {
let mut template = format!("complete -c {}", root_command);
if !parent_cmds.is_empty() {
template.push_str(format!(" -n '__fish_seen_subcommand_from {}'",
command).as_str());
} else if has_no_subcommand_fn {
template.push_str(format!(" -n '__fish_{}_no_subcommand'",
comp_gen.p.meta.bin_name.as_ref().unwrap()).as_str());
}
if let Some(data) = flag.short {
template.push_str(format!(" -s {}", data).as_str());
}
if let Some(data) = flag.long {
template.push_str(format!(" -l {}", data).as_str());
}
if let Some(data) = flag.help {
template.push_str(format!(" -d '{}'", data).as_str());
}
buffer.push_str(template.as_str());
buffer.push_str("\n");
}
if subcommands.len() > 1 {
for subcommand in subcommands {
let mut template = format!("complete -c {}", root_command);
if !parent_cmds.is_empty() {
template.push_str(format!(" -n '__fish_seen_subcommand_from {}'",
subcommand).as_str());
} else if has_no_subcommand_fn {
template.push_str(format!(" -n '__fish_{}_no_subcommand'",
comp_gen.p.meta.bin_name.as_ref().unwrap()).as_str());
}
template.push_str(" -f");
template.push_str(format!(" -a '{}'", subcommand).as_str());
buffer.push_str(template.as_str());
buffer.push_str("\n");
}
}
// generate options of subcommands
for subcommand in &comp_gen.p.subcommands {
let sub_comp_gen = ComplGen::new(&subcommand.p);
let mut sub_parent_cmds = parent_cmds.clone();
sub_parent_cmds.push(command);
gen_fish_inner(root_command,
&sub_comp_gen,
sub_parent_cmds,
buffer,
has_no_subcommand_fn);
}
}

4
src/lib.rs
View file

@ -446,6 +446,8 @@ mod shell {
#[derive(Debug, Copy, Clone)]
pub enum Shell {
/// Generates a .sh completion file for the Bourne Again SHell (BASH)
Bash
Bash,
/// Generates a .fish completion file for the friendly interactive shell (fish)
Fish,
}
}