foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-01-03 04:48:52 -05:00
Code Issues Packages 1 Wiki Activity

fix(cli/args): update value_name of inspect args to resolve broken completions (#17287)

Browse source 
This PR updates the name used in `clap::Arg::value_name` for the
`--inspect*` flags from `HOST:PORT` to `HOST_AND_PORT` because the
former causes an arguments error when using shell completions in the
`zsh` shell.
This commit is contained in:
Geert-Jan Zwiers 2023-01-09 13:29:43 +01:00 committed by GitHub
parent c41d4ff90e
commit fa175d8cda
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
cli/args/flags.rs
View file

@ -1952,7 +1952,7 @@ fn inspect_args(app: Command) -> Command {
.arg( .arg(
Arg::new("inspect") Arg::new("inspect")
.long("inspect") .long("inspect")
.value_name("HOST:PORT") .value_name("HOST_AND_PORT")
.help("Activate inspector on host:port (default: 127.0.0.1:9229)") .help("Activate inspector on host:port (default: 127.0.0.1:9229)")
.min_values(0) .min_values(0)
.max_values(1) .max_values(1)
@ -1963,7 +1963,7 @@ fn inspect_args(app: Command) -> Command {
.arg( .arg(
Arg::new("inspect-brk") Arg::new("inspect-brk")
.long("inspect-brk") .long("inspect-brk")
.value_name("HOST:PORT") .value_name("HOST_AND_PORT")
.help( .help(
"Activate inspector on host:port, wait for debugger to connect and break at the start of user script", "Activate inspector on host:port, wait for debugger to connect and break at the start of user script",
) )
@ -1976,7 +1976,7 @@ fn inspect_args(app: Command) -> Command {
.arg( .arg(
Arg::new("inspect-wait") Arg::new("inspect-wait")
.long("inspect-wait") .long("inspect-wait")
.value_name("HOST:PORT") .value_name("HOST_AND_PORT")
.help( .help(
"Activate inspector on host:port and wait for debugger to connect before running user code", "Activate inspector on host:port and wait for debugger to connect before running user code",
) )
@ -5530,6 +5530,23 @@ mod tests {
assert!(r.is_err(),); assert!(r.is_err(),);
} }
#[test]
fn test_no_colon_in_value_name() {
let app =
runtime_args(Command::new("test_inspect_completion_value"), true, true);
let inspect_args = app
.get_arguments()
.filter(|arg| arg.get_id() == "inspect")
.collect::<Vec<_>>();
// The value_name cannot have a : otherwise it breaks shell completions for zsh.
let value_name = "HOST_AND_PORT";
let arg = inspect_args
.iter()
.any(|v| v.get_value_names().unwrap() == [value_name]);
assert_eq!(arg, true);
}
#[test] #[test]
fn test_with_flags() { fn test_with_flags() {
#[rustfmt::skip] #[rustfmt::skip]