1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
use std::fs;
use std::fs::create_dir_all;
use std::io;
use clap::{Arg, ArgMatches, Command, ValueHint};
use clap_complete::Shell;
#[must_use]
pub fn add_subcommand(command: Command) -> Command {
#[allow(clippy::let_and_return)] let c = command.subcommand(
Command::new("complete").arg(
Arg::new("shell")
.num_args(1)
.short('s')
.long("shell")
.help("Explicitly choose which shell to output.")
.value_hint(ValueHint::Other),
),
);
#[cfg(any(unix, target_os = "redox"))]
{
c.arg(Arg::new("print").short('p').long("print").help(
"Print the shell completion to stdout instead of writing to default file.\n\
Does nothing when using shells for which \
the installation location isn't implemented.",
))
.about(
"Generate completions for the detected/selected shell and \
put the completions in appropriate directories.\n\
Currently supports Fish, Bash, Zsh, Elvish, and PowerShell. \
Fish, Bash, and Zsh are installed \
automatically (when not using the --print flag).",
)
}
#[cfg(not(any(unix, target_os = "redox")))]
{
c.about(
"Generate completions for the detected/selected shell. \
Currently supports Fish, Bash, Zsh, Elvish, and PowerShell.",
)
}
}
#[must_use = "check whether or not to exit"]
pub fn test_subcommand(matches: &ArgMatches, mut command: Command) -> Option<Result<(), String>> {
matches.subcommand_matches("complete").map(|matches| {
let shell = {
let mut name = matches
.get_one::<String>("shell")
.map(Into::into)
.ok_or(())
.or_else(|()| {
eprintln!("Trying to get your shell.");
query_shell::get_shell()
.map_err(|_| {
"failed to detect shell, please explicitly supply it".to_owned()
})
.map(|shell| shell.to_str().to_owned())
})?;
name.make_ascii_lowercase();
match name.as_str() {
"bash" => Shell::Bash,
"fish" => Shell::Fish,
"zsh" => Shell::Zsh,
"pwsh" | "powershell" => Shell::PowerShell,
"elvish" => Shell::Elvish,
_ => return Err("unsupported explicit shell".into()),
}
};
let bin_name = command
.get_bin_name()
.unwrap_or_else(|| command.get_name())
.to_owned();
#[cfg(any(unix, target_os = "redox"))]
{
if matches.get_flag("print") || !matches!(shell, Shell::Fish | Shell::Bash | Shell::Zsh)
{
clap_complete::generate(shell, &mut command, &bin_name, &mut io::stdout());
Ok(())
} else {
let mut buffer = Vec::with_capacity(512);
clap_complete::generate(shell, &mut command, &bin_name, &mut buffer);
write_shell(shell, &buffer, &bin_name).map_err(|err| match err.kind() {
io::ErrorKind::PermissionDenied => {
"Failed to write shell. Permission denied.".to_owned()
}
_ => format!("Failed to write shell: {}", err),
})?;
Ok(())
}
}
#[cfg(not(any(unix, target_os = "redox")))]
{
clap_complete::generate(shell, &mut command, &bin_name, &mut io::stdout());
Ok(())
}
})
}
#[cfg(any(unix, target_os = "redox"))]
fn write_shell(shell: Shell, data: &[u8], bin_name: &str) -> Result<(), io::Error> {
let path = match shell {
Shell::Fish => {
let dirs = xdg::BaseDirectories::new()?;
dirs.place_config_file(format!("fish/completions/{bin_name}.fish"))?
}
Shell::Bash => format!("/usr/share/bash-completion/completions/{bin_name}").into(),
Shell::Zsh => format!("/usr/share/zsh/functions/Completion/Base/_{bin_name}").into(),
_ => unreachable!("trying to write unsupported shell"),
};
if let Some(parent) = path.parent() {
create_dir_all(parent)?;
}
eprintln!("Writing completions to {}", path.display());
fs::write(path, data)?;
Ok(())
}