Subcommand aliases not included in completion scripts #4265

martinvonz · 2022-09-26T21:39:22Z

Please complete the following tasks

I have searched the discussions
I have searched the open and rejected issues

Rust Version

1.63.0

Clap Version

3.2.22

Minimal reproducible code

use std::io::{stdout, Write};
use clap;
use clap::CommandFactory;

#[derive(clap::Parser, Clone, Debug)]
enum App {
    #[clap(alias = "bar")]
    Foo(FooArgs),
}

#[derive(clap::Args, Clone, Debug)]
struct FooArgs {
    my_flag: bool,
}

fn main() {
    let mut app = App::command().disable_help_flag(true).disable_help_subcommand(true);
    let mut buf = vec![];
    clap_complete::generate(clap_complete::Shell::Bash, &mut app, "test", &mut buf);
    stdout().write_all(&mut buf).unwrap();
}

Steps to reproduce the bug with the above code

Run the program to print out a completion script for Bash

Actual Behaviour

Sourcing the completion script and then running test <TAB> will not suggest bar and test bar <TAB> will not suggest --my-flag.

Expected Behaviour

test bar <TAB> should suggest --my-flag. I'm not sure if I think test <TAB> should suggest both foo and bar; perhaps the current behavior of not suggesting aliases is best?

The same bug exists in the Fish completion script. I haven't tried others (or checked the code).

I actually noticed the bug because my tool has jj log command and a jj operation/op log command, and I ran jj op log <TAB>, which suggested arguments that are for jj log. That's because the op (an alias for operation) is ignored and completion is run for jj log instead.

Additional Context

No response

Debug Output

No response

The text was updated successfully, but these errors were encountered:

epage · 2022-09-26T22:02:40Z

alias is hidden in --help and you need visible_alias to show up in --help.

We've had some back and forth on whether things that are hidden from help should show up in completions

When we resolve #3166, my thought is to handle this according to #3951

martinvonz · 2022-09-26T23:21:36Z

alias is hidden in --help and you need visible_alias to show up in --help.

That makes sense, but it doesn't seem to affect the completion script.

Are you open to a PR to add visible aliases to the completion scripts if I can figure out how?

epage · 2022-09-27T01:02:53Z

Yes

Supports visible aliases:

zsh: https://github.com/clap-rs/clap/blob/master/clap_complete/src/shells/zsh.rs#L170

Doesn't

martinvonz · 2022-09-28T16:45:21Z

I've noticed a few other bugs while working on this. Do you prefer that I file separate bugs for those? Looking at past release notes, it doesn't look like you require a bug for each fix, but I don't mind creating them if you prefer.

epage · 2022-09-28T16:50:03Z

Separate issues are good in case

There is discussion around the requirements (I prefer PRs to be focused on the implementation)
In case not all of them get resolved together

I would at least ask for separate commits for each one. If a change is likely to have more discussion, having that in a separate PR helps.

This continues the work started with the fix for clap-rs#4273. There was another bug caused by using the subcommand names without considering their position in the argument list. If the user enters `git diff log <TAB>`, we build up a string that identifies the subcommand. We ended up making the string `git__diff__log` in this case because we appended `__log` without considering the current state. Since `git__diff__log` does not correspond to an actual command, we wouldn't provide any suggestions. This commit restructures the code so we walk subcommands and subsubcommands in `bash.rs`. While walking those, we build up a list containing triples of the parent `$cmd` name (e.g. `git__diff`), the current command's name (e.g. `log`), and the `$cmd` for the current command. We then build the shell script's case arms based on that information. We could instead have fixed clap-rs#4280 by using the second element in the pair returned from `utils::all_subcommands()` (a stringified list of the subcommand path) instead of the first one. However, that would not have helped us solve clap-rs#4265. Closes clap-rs#4280

With the previous fixes for clap-rs#4273 and clap-rs#4280 in place, it's now easy to add support for subcommand aliases, which this commit does. This addresses clap-rs#4265 for Bash.

This continues the work started with the fix for clap-rs#4273. There was another bug caused by using the subcommand names without considering their position in the argument list. If the user enters `git diff log <TAB>`, we build up a string that identifies the subcommand. We ended up making the string `git__diff__log` in this case because we appended `__log` without considering the current state. Since `git__diff__log` does not correspond to an actual command, we wouldn't provide any suggestions. This commit restructures the code so we walk subcommands and subsubcommands in `bash.rs`. While walking those, we build up a list containing triples of the parent `$cmd` name (e.g. `git__diff`), the current command's name (e.g. `log`), and the `$cmd` for the current command. We then build the shell script's case arms based on that information. We could instead have fixed clap-rs#4280 by using the second element in the pair returned from `utils::all_subcommands()` (a stringified list of the subcommand path) instead of the first one. However, that would not have helped us solve clap-rs#4265. Closes clap-rs#4280

With the previous fixes for clap-rs#4273 and clap-rs#4280 in place, it's now easy to add support for subcommand aliases, which this commit does. This addresses clap-rs#4265 for Bash.

This continues the work started with the fix for clap-rs#4273. There was another bug caused by using the subcommand names without considering their position in the argument list. If the user enters `git diff log <TAB>`, we build up a string that identifies the subcommand. We ended up making the string `git__diff__log` in this case because we appended `__log` without considering the current state. Since `git__diff__log` does not correspond to an actual command, we wouldn't provide any suggestions. This commit restructures the code so we walk subcommands and subsubcommands in `bash.rs`. While walking those, we build up a list containing triples of the parent `$cmd` name (e.g. `git__diff`), the current command's name (e.g. `log`), and the `$cmd` for the current command. We then build the shell script's case arms based on that information. We could instead have fixed clap-rs#4280 by using the second element in the pair returned from `utils::all_subcommands()` (a stringified list of the subcommand path) instead of the first one. However, that would not have helped us solve clap-rs#4265. Closes clap-rs#4280

With the previous fixes for clap-rs#4273 and clap-rs#4280 in place, it's now easy to add support for subcommand aliases, which this commit does. This addresses clap-rs#4265 for Bash.

T0mstone · 2023-10-31T16:26:07Z

Supports visible aliases:

zsh: https://github.com/clap-rs/clap/blob/master/clap_complete/src/shells/zsh.rs#L170

Although the zsh completion supports listing the aliases for test <TAB>, there is currently still the bug with test bar <TAB> not suggesting --my-flag (or anything else, for that matter).

martinvonz added the C-bug Category: Updating dependencies label Sep 26, 2022

epage added A-completion Area: completion generator E-help-wanted Call for participation: Help is requested to fix this issue. E-easy Call for participation: Experience needed to fix: Easy / not much labels Sep 28, 2022

martinvonz mentioned this issue Sep 28, 2022

Bash completion for git diff git suggests only top-level completions #4273

Closed

2 tasks

martinvonz mentioned this issue Sep 29, 2022

Generate subcommand alias #4284

Closed

martinvonz mentioned this issue Sep 29, 2022

Generate subcommand alias #4289

Merged

figsoda mentioned this issue Feb 3, 2023

Zsh completions don't work if subcommand alias is used ouch-org/ouch#357

Open

istudyatuni mentioned this issue Jan 27, 2024

Autocomplete in CLI doesn't work when using alias of command typst/typst#3281

Open

1 task

martinvonz mentioned this issue Feb 5, 2024

document how to use powershell and elvish completions martinvonz/jj#2947

Open

This was referenced Mar 21, 2024

completions for subcommand aliases #5243

Closed

feat(complete): support command alias completions #5412

Open

pzmarzly linked a pull request Apr 27, 2024 that will close this issue

feat(complete): generate completions for visible aliases #5476

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Subcommand aliases not included in completion scripts #4265

Subcommand aliases not included in completion scripts #4265

martinvonz commented Sep 26, 2022

epage commented Sep 26, 2022

martinvonz commented Sep 26, 2022

epage commented Sep 27, 2022

martinvonz commented Sep 28, 2022

epage commented Sep 28, 2022

T0mstone commented Oct 31, 2023

Subcommand aliases not included in completion scripts #4265

Subcommand aliases not included in completion scripts #4265

Comments

martinvonz commented Sep 26, 2022

Please complete the following tasks

Rust Version

Clap Version

Minimal reproducible code

Steps to reproduce the bug with the above code

Actual Behaviour

Expected Behaviour

Additional Context

Debug Output

epage commented Sep 26, 2022

martinvonz commented Sep 26, 2022

epage commented Sep 27, 2022

martinvonz commented Sep 28, 2022

epage commented Sep 28, 2022

T0mstone commented Oct 31, 2023