Add shell completion #515
Merged
Add shell completion #515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #515 +/- ##
==========================================
- Coverage 60.91% 60.89% -0.02%
==========================================
Files 87 87
Lines 12658 12661 +3
==========================================
Hits 7710 7710
- Misses 4948 4951 +3 |
|
@creepinson |
|
You're right, I had used vscode's rust-analyzer formatter assuming that would work fine. |
Furisto
reviewed
Dec 4, 2021
| use clap_generate::{generate, Generator, Shell}; | ||
| use std::io; | ||
|
|
||
| #[derive(Debug, Parser)] |
There was a problem hiding this comment.
youki -h currently does not have a description for this command
Suggested change
| #[derive(Debug, Parser)] | |
| /// Generate scripts for shell completion | |
| #[derive(Debug, Parser)] |
utam0k
reviewed
Dec 4, 2021
| pub generator: Shell, | ||
| } | ||
|
|
||
| pub fn print_completions<G: Generator>(gen: G, app: &mut App) -> Result<(), anyhow::Error> { |
Furisto
requested changes
Dec 4, 2021
crates/youki/src/main.rs
Outdated
Comment on lines
105
to
107
| SubCommand::Completion(parser) => { | ||
| commands::completion::print_completions(parser.generator, &mut app) | ||
| } |
There was a problem hiding this comment.
Suggested change
| SubCommand::Completion(parser) => { | |
| commands::completion::print_completions(parser.generator, &mut app) | |
| } | |
| SubCommand::Completion(completion) => { | |
| commands::completion::completion(completion, &mut app) | |
| } |
Comment on lines
6
to
9
| pub struct CompletionParser { | ||
| #[clap(long = "generator", short = 'g', arg_enum)] | ||
| pub generator: Shell, | ||
| } |
There was a problem hiding this comment.
Suggested change
| pub struct CompletionParser { | |
| #[clap(long = "generator", short = 'g', arg_enum)] | |
| pub generator: Shell, | |
| } | |
| pub struct Completion { | |
| #[clap(long = "shell", short = 's', arg_enum)] | |
| pub shell: Shell, | |
| } |
crates/youki/src/main.rs
Outdated
| @@ -46,6 +46,7 @@ enum SubCommand { | |||
|
|
|||
| // Youki specific extensions | |||
| Info(info::Info), | |||
| Completion(commands::completion::CompletionParser), | |||
There was a problem hiding this comment.
Suggested change
| Completion(commands::completion::CompletionParser), | |
| Completion(completion::Completion), |
Comment on lines
11
to
15
| pub fn print_completions<G: Generator>(gen: G, app: &mut App) -> Result<(), anyhow::Error> { | ||
| generate(gen, app, app.get_name().to_string(), &mut io::stdout()); | ||
|
|
||
| Ok(()) | ||
| } |
There was a problem hiding this comment.
Suggested change
| pub fn print_completions<G: Generator>(gen: G, app: &mut App) -> Result<(), anyhow::Error> { | |
| generate(gen, app, app.get_name().to_string(), &mut io::stdout()); | |
| Ok(()) | |
| } | |
| pub fn print_completions(args: Completion, app: &mut App) -> Result<()> { | |
| generate(args.shell, app, app.get_name().to_string(), &mut io::stdout()); | |
| Ok(()) | |
| } |
|
Minor stuff, the style should be consistent with the other commands. |
- Make completion command consistent with the style of the other commands - Rename the "generator" argument to "shell" - Use the anyhow::Result type
|
Looks like I messed up the order of the comment and the |
Furisto
approved these changes
Dec 5, 2021
|
Great! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
I added shell completion for zsh, bash or any other shell that clap_generate supports.
This is how I used it in my setup with zsh: