tab completions #278

brson · 2016-04-06T17:45:16Z

I've been using it for almost a week and seems great! I only miss tab completions, that would be awesome :slight_smile: thanks Brian!

Hm, after thinking about this further, tab completions are going to be tricky. rustup does not require root to install but completions are usually installed to /etc. I really don't want to require admin just for that. I wonder if we might further frob the shell startup files (like we already to to modify PATH) to load completions.

Source.

japaric · 2016-04-15T21:18:48Z

I wonder if we might further frob the shell startup files (like we already to to modify PATH) to load completions.

FWIW, in my case I use zsh and I enable the cargo auto completions (that rustup installs) without touching the /etc directory by modifying the fpath variable in my zshrc as shown here. I also use the oh-my-zsh framework and I've noticed that I need to modify the fpath variable before sourcing the oh-my-zsh framework.

Disclaimer: I don't really grok zsh internals and perhaps there is a way to enable cargo autocompletions after the oh-my-zsh framework has been loaded.

P.S. I don't really like that CLI tools modify my zshrc, I usually undo/modify what they do 😄. I would be happy if rustup just installs a _rustup completion file somewhere in the .multirust folder like it does with _cargo.

kbknapp · 2016-07-02T03:30:37Z

@brson @japaric

I've just added the ability to generate bash completions for a cli with clap at compile time. Here's a gist of the generated completion script for rustup

And a demo:

I have a branch on my fork where I generated the completions, although before I'd put in a PR there are few opinionated portions that I'd rather a project maintainer look at prior

having to move the rustup_mode::cli function into a separate file in order to include via the build.rs.
there's a strange issue where I couldn't use help::*; from rustup_app.rs so I had to include! it.
finally, the output of the completion script goes to OUT_DIR

Granted this is only a Bash completion script, but it's at least a step in a direction (if it's the right direction is TBD). I personally use ZSH, so that's next on my list.

Diggsey · 2016-07-02T10:50:43Z

@kbknapp Wow, that's awesome!

wuranbo · 2016-07-02T14:21:23Z

go go go

brson · 2016-07-05T18:27:52Z

@kbknapp Sweet! That's really clever.

I'm fine doing the conversion, but I'd still like to wait until we understand how to install them before pulling trigger.

knight42 · 2016-08-25T04:00:12Z

@kbknapp Any progress now? It's a pain to me when auto-completion is unable to use.

kbknapp · 2016-08-26T13:52:17Z

@knight42 I haven't added ZSH support yet. Once I do I'll post back here.

knight42 · 2016-08-26T15:12:27Z

@kbknapp Great! It's better to generate the completion script automatically. I am looking forward to it!

This commit adds two sections to the command line options to enable building of Shell Completion Scripts to `stdout`. This allows these scripts to be redirected to a file, effectively allowing the user to install these scripts at the location of their choosing. The arguments only accept the values `zsh`, `fish` and `bash`, which clap guards against. To use these scripts one must do one of the following *Note:* The commands `rustup completions <SHELL>` and `rustup self --completions <SHELL>` are synonyms for each other, and do the exact same thing. ``` $ rustup completions bash > /path/to/completions/dir/rustup.bash-completion ``` ``` $ rustup completions fish > ~/.config/fish/completions/rustup.fish ``` ``` $ mkdir ~/.zfunc $ rustup completions zsh > ~/.zfunc/_rustup $ echo "fpath+=~/.zfunc\ncominit" >> ~/.zshrc $ exec zsh ``` Relates to rust-lang#278

kbknapp · 2016-10-24T04:25:41Z

@knight42

I've just added ZSH support to clap (finally! 🎉), and put in a PR to rustup to add it. The PR also includes Bash, and Fish support as well.

Here's a gif of the ZSH support though:

knight42 · 2016-10-24T05:09:08Z

@kbknapp Awesome, love it!

This commit adds two sections to the command line options to enable building of Shell Completion Scripts to `stdout`. This allows these scripts to be redirected to a file, effectively allowing the user to install these scripts at the location of their choosing. The arguments only accept the values `zsh`, `fish` and `bash`, which clap guards against. To use these scripts one must do one of the following *Note:* The commands `rustup completions <SHELL>` and `rustup self --completions <SHELL>` are synonyms for each other, and do the exact same thing. ``` $ rustup completions bash > /path/to/completions/dir/rustup.bash-completion ``` ``` $ rustup completions fish > ~/.config/fish/completions/rustup.fish ``` ``` $ mkdir ~/.zfunc $ rustup completions zsh > ~/.zfunc/_rustup $ echo "fpath+=~/.zfunc\ncominit" >> ~/.zshrc $ exec zsh ``` Relates to rust-lang#278

est31 · 2016-10-26T17:02:49Z

Thanks for the autocompletion feature @kbknapp I really like it!

Would it be possible to extend the tab completion support to include things rustup can derive? Like when you type rustup override add<TAB><TAB> it should give you a list of toolchains.

Its obviously more complicated, but should be doable, no?

flatpak manages to do this btw, you can press flatpak run org.app.<TAB> and it will autocomplete the app name.

kbknapp · 2016-10-26T18:07:03Z

@est31 not yet, but that is the exact topic of clap-rs/clap#568

kbknapp · 2016-10-26T18:08:13Z

I should add you can do this manually, but it's not built in to clap yet :will:

This commit adds two sections to the command line options to enable building of Shell Completion Scripts to `stdout`. This allows these scripts to be redirected to a file, effectively allowing the user to install these scripts at the location of their choosing. The arguments only accept the values `zsh`, `fish` and `bash`, which clap guards against. To use these scripts one must do one of the following *Note:* The commands `rustup completions <SHELL>` and `rustup self --completions <SHELL>` are synonyms for each other, and do the exact same thing. ``` $ rustup completions bash > /path/to/completions/dir/rustup.bash-completion ``` ``` $ rustup completions fish > ~/.config/fish/completions/rustup.fish ``` ``` $ mkdir ~/.zfunc $ rustup completions zsh > ~/.zfunc/_rustup $ echo "fpath+=~/.zfunc\ncominit" >> ~/.zshrc $ exec zsh ``` Relates to rust-lang#278

Diggsey · 2017-05-04T20:43:25Z

I think this can be considered complete?

knight42 mentioned this issue Aug 25, 2016

Add basic autocompletion for Zsh #689

Merged

Diggsey closed this as completed May 4, 2017

jmwright mentioned this issue Feb 6, 2019

Allow Sub-Components to be Accessed from the Top Level 7BIndustries/sliderule-cli#36

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tab completions #278

tab completions #278

brson commented Apr 6, 2016

japaric commented Apr 15, 2016

kbknapp commented Jul 2, 2016

Diggsey commented Jul 2, 2016

wuranbo commented Jul 2, 2016

brson commented Jul 5, 2016

knight42 commented Aug 25, 2016

kbknapp commented Aug 26, 2016

knight42 commented Aug 26, 2016

kbknapp commented Oct 24, 2016

knight42 commented Oct 24, 2016

est31 commented Oct 26, 2016

kbknapp commented Oct 26, 2016

kbknapp commented Oct 26, 2016

Diggsey commented May 4, 2017

tab completions #278

tab completions #278

Comments

brson commented Apr 6, 2016

japaric commented Apr 15, 2016

kbknapp commented Jul 2, 2016

Diggsey commented Jul 2, 2016

wuranbo commented Jul 2, 2016

brson commented Jul 5, 2016

knight42 commented Aug 25, 2016

kbknapp commented Aug 26, 2016

knight42 commented Aug 26, 2016

kbknapp commented Oct 24, 2016

knight42 commented Oct 24, 2016

est31 commented Oct 26, 2016

kbknapp commented Oct 26, 2016

kbknapp commented Oct 26, 2016

Diggsey commented May 4, 2017