Automatic shell completion generation using xtask. #1068
Conversation
This changes the default behavior of the `cargo run` command for xtasks to hide the compilation info. This makes sense as xtask's are run as a program, and showing the compilation info every time clutters stdout with unrelated info.
Moving the `clap::Command` used internally by ncspot to a library allows it to be easily shared between different packages (xtask and ncspot itself). This commit also reworks the xtasks to use clap for parsing the xtask arguments, which simplifies writing new xtasks.
Add automatic generation of shell completion scripts for various shells (the ones supported by `clap_complete`). The scripts can be generated using the `generate-shell-completion` xtask, which outputs the shell script to stdout.
|
I feel like I'm not contributing a lot of code in the last few PRs... Anyways, automatic shell completion script generation using xtask. Now we never have to type I know this isn't really required but I like when apps adhere to the most common conventions/rules of an OS, so I thought being able to generate shell completions would be nice for package maintainers, so they can add shell completion scripts with the package. What do you think? 😁 The reason I keep these as a draft for now is related to an issue I created recently. I'm wondering how packagers will find these new options. One option is just to add info to the README but I don't think everyone would notice that. Another option is to hope the packagers notice this in the changelog. I think the best option would be as mentioned in issue #1061, where there is a separate section for packagers, mentioned clearly in the top level README. The files could also be provided upstream so packagers only have to install them. Many options... Next up: Appstream for nicer Flathub? |
This adds the option to automatically generate shell completion scripts for a variety of shells (currently bash, zsh, fish, elvish and powershell) using
cargo xtask generate-shell-completion. It uses the crateclap_completeto automatically create these completions based on theclap::Commandstruct. It could be handy for package maintainers to add these scripts to their package.