feat(complete): Added an map api for pathCompleter

Author: Gmin2

clap_complete/src/engine/custom.rs

@@ -216,6 +216,8 @@ pub struct PathCompleter {
     #[allow(clippy::type_complexity)]
     filter: Option<Box<dyn Fn(&std::path::Path) -> bool + Send + Sync>>,
     stdio: bool,
+    #[allow(clippy::type_complexity)]
+    mapper: Option<Box<dyn Fn(CompletionCandidate) -> CompletionCandidate + Send + Sync>>,
 }
 
 impl PathCompleter {
@@ -225,6 +227,7 @@ impl PathCompleter {
             filter: None,
             current_dir: None,
             stdio: false,
+            mapper: None,
         }
     }
 
@@ -258,6 +261,15 @@ impl PathCompleter {
         self.current_dir = Some(path.into());
         self
     }
+
+    /// Transform completion candidates after filtering
+    pub fn map(
+        mut self,
+        mapper: impl Fn(CompletionCandidate) -> CompletionCandidate + Send + Sync + 'static,
+    ) -> Self {
+        self.mapper = Some(Box::new(mapper));
+        self
+    }
 }
 
 impl Default for PathCompleter {
@@ -275,6 +287,12 @@ impl ValueCompleter for PathCompleter {
             current_dir_actual.as_deref()
         });
         let mut candidates = complete_path(current, current_dir, filter);
+        if let Some(mapper) = &self.mapper {
+            candidates = candidates
+                .into_iter()
+                .map(|candidate| mapper(candidate))
+                .collect();
+        }
         if self.stdio && current.is_empty() {
             candidates.push(CompletionCandidate::new("-").help(Some("stdio".into())));
         }

clap_complete/tests/testsuite/engine.rs

@@ -1191,3 +1191,55 @@ fn complete(cmd: &mut Command, args: impl AsRef<str>, current_dir: Option<&Path>
         .collect::<Vec<_>>()
         .join("\n")
 }
+
+#[test]
+fn suggest_value_path_with_mapper() {
+    let testdir = snapbox::dir::DirRoot::mutable_temp().unwrap();
+    let testdir_path = testdir.path().unwrap();
+    fs::write(testdir_path.join("a_file"), "").unwrap();
+    fs::write(testdir_path.join("b_file"), "").unwrap();
+    fs::create_dir_all(testdir_path.join("c_dir")).unwrap();
+    fs::create_dir_all(testdir_path.join("d_dir")).unwrap();
+    
+    fs::write(testdir_path.join("c_dir").join("Cargo.toml"), "").unwrap();
+    
+    let mut cmd = Command::new("dynamic")
+        .arg(
+            clap::Arg::new("input")
+                .long("input")
+                .short('i')
+                .add(ArgValueCompleter::new(
+                    PathCompleter::dir()
+                        .map(|candidate| {
+                            let path = Path::new(candidate.get_value());
+                            let cargo_toml_path = path.join("Cargo.toml");
+                            let has_cargo_toml = cargo_toml_path.exists();
+                            
+                            if has_cargo_toml {
+                                candidate
+                                    .help(Some("Addable cargo package".into()))
+                                    .display_order(Some(0))
+                            } else {
+                                candidate.display_order(Some(1))
+                            }
+                        }),
+                )),
+        )
+        .args_conflicts_with_subcommands(true);
+    
+    let original_dir = std::env::current_dir().unwrap();
+    std::env::set_current_dir(testdir_path).unwrap();
+    
+    let result = complete!(cmd, "--input [TAB]", current_dir = None);
+    
+    std::env::set_current_dir(original_dir).unwrap();
+    
+    assert_data_eq!(
+        result,
+        snapbox::str![[r#"
+c_dir/	Addable cargo package
+.
+d_dir/
+"#]],
+    );
+}