feat(cli): Enable dynamic completions

Author: alerque

Cargo.lock

@@ -18,7 +18,7 @@ required-features = ["cli"]
 
 [features]
 default = ["cli", "bash", "elvish", "fish", "manpage", "powershell", "zsh"]
-completions = ["cli", "clap_complete"]
+completions = ["cli", "dep:clap_complete"]
 cli = ["clap"]
 bash = ["completions"]
 elvish = ["completions"]
@@ -40,20 +40,26 @@ snafu = "0.8"
   optional = true
   features = [ "derive", "wrap_help" ]
 
+  [dependencies.clap_complete]
+  version = "4.5"
+  optional = true
+  features = [ "unstable-dynamic" ]
+
   [dependencies.git2]
   version = "0.19"
   default-features = false
 
 [build-dependencies]
 
-  [build-dependencies.clap_complete]
-  version = "4.5"
-  optional = true
-
   [build-dependencies.clap_mangen]
   version = "0.2"
   optional = true
 
+  [build-dependencies.clap_complete]
+  version = "4.5"
+  optional = true
+  features = [ "unstable-dynamic" ]
+
   [build-dependencies.clap]
   version = "4.5"
   optional = true

Cargo.toml

@@ -40,15 +40,20 @@ type Result<T, E = Error> = std::result::Result<T, E>;
 
 fn main() -> Result<()> {
     let version = option_env!("VERGEN_GIT_DESCRIBE").unwrap_or_else(|| env!("CARGO_PKG_VERSION"));
-    let app = Cli::command().version(version);
-    let matches = app.get_matches();
+    let mut app = Cli::command().version(version);
+    let matches = app.clone().get_matches();
     let positionals = matches.get_many::<String>("paths");
     let repo = get_repo().context(NoRepositorySnafu)?;
     let mut opts = git_warp_time::Options::new()
         .dirty(matches.get_flag("dirty"))
         .ignored(matches.get_flag("ignored"))
         .ignore_older(matches.get_flag("ignore_older"))
         .verbose(!matches.get_flag("quiet"));
+    if let Some(completions) =
+        matches.get_one::<clap_complete::dynamic::CompleteCommand>("complete")
+    {
+        completions.complete(&mut app);
+    }
     if matches.contains_id("paths") {
         let mut paths: FileSet = FileSet::new();
         for path in positionals.context(UnableToFormPathSnafu)? {

src/bin/git-warp-time.rs

@@ -2,12 +2,17 @@
 // SPDX-License-Identifier: GPL-3.0-only
 
 use clap::Parser;
+use clap_complete::dynamic::{ArgValueCompleter, CompleteCommand, CompletionCandidate};
 
 /// CLI utility that resets the timestamps of files in a Git repository working directory
 /// to the exact timestamp of the last commit which modified each file.
 #[derive(Parser, Debug)]
 #[clap(author, bin_name = "git-warp-time")]
 pub struct Cli {
+    /// generate completions
+    #[command(subcommand)]
+    complete: Option<CompleteCommand>,
+
     /// Include files tracked by Git but modifications in the working tee
     #[clap(short, long)]
     pub dirty: bool,
@@ -24,6 +29,14 @@ pub struct Cli {
     #[clap(short, long)]
     pub quiet: bool,
 
+    /// Test
+    #[clap(add = ArgValueCompleter::new(|| { vec![
+            CompletionCandidate::new("foo"),
+            CompletionCandidate::new("bar"),
+            CompletionCandidate::new("baz")] }))]
+    pub bag: String,
+
     /// Optional list of paths to operate on instead of default which is all files tracked by Git
+    #[clap(value_hint = clap::ValueHint::FilePath)]
     pub paths: Vec<String>,
 }