fix(complete): Hide dot files on dynamic completer

epage · epage · commit 9d7f2128f770 · 2025-08-11T15:56:48.000-05:00
diff --git a/clap_complete/src/engine/custom.rs b/clap_complete/src/engine/custom.rs
@@ -333,9 +333,10 @@ pub(crate) fn complete_path(
         }
 
         if entry.metadata().map(|m| m.is_dir()).unwrap_or(false) {
-            let mut suggestion = prefix.join(raw_file_name);
+            let mut suggestion = prefix.join(&raw_file_name);
             suggestion.push(""); // Ensure trailing `/`
-            let candidate = CompletionCandidate::new(suggestion.as_os_str().to_owned());
+            let candidate = CompletionCandidate::new(suggestion.as_os_str().to_owned())
+                .hide(is_hidden(&raw_file_name));
 
             if is_wanted(&entry.path()) {
                 completions.push(candidate);
@@ -344,8 +345,9 @@ pub(crate) fn complete_path(
             }
         } else {
             if is_wanted(&entry.path()) {
-                let suggestion = prefix.join(raw_file_name);
-                let candidate = CompletionCandidate::new(suggestion.as_os_str().to_owned());
+                let suggestion = prefix.join(&raw_file_name);
+                let candidate = CompletionCandidate::new(suggestion.as_os_str().to_owned())
+                    .hide(is_hidden(&raw_file_name));
                 completions.push(candidate);
             }
         }
@@ -357,6 +359,10 @@ pub(crate) fn complete_path(
     completions
 }
 
+fn is_hidden(file_name: &OsStr) -> bool {
+    file_name.starts_with(".")
+}
+
 fn split_file_name(path: &std::path::Path) -> (&std::path::Path, &OsStr) {
     // Workaround that `Path::new("name/").file_name()` reports `"name"`
     if path_has_name(path) {
diff --git a/clap_complete/tests/testsuite/engine.rs b/clap_complete/tests/testsuite/engine.rs
@@ -517,10 +517,6 @@ fn suggest_value_hint_file_path() {
     assert_data_eq!(
         complete!(cmd, "--input [TAB]", current_dir = Some(testdir_path)),
         snapbox::str![[r#"
-.a_file
-.b_file
-.c_dir/
-.d_dir/
 a_file
 b_file
 c_dir/
@@ -535,10 +531,6 @@ d_dir/
     assert_data_eq!(
         complete!(cmd, "--input .[TAB]", current_dir = Some(testdir_path)),
         snapbox::str![[r#"
-./.a_file
-./.b_file
-./.c_dir/
-./.d_dir/
 ./a_file
 ./b_file
 ./c_dir/
@@ -581,12 +573,8 @@ fn suggest_value_path_file() {
     assert_data_eq!(
         complete!(cmd, "--input [TAB]", current_dir = Some(testdir_path)),
         snapbox::str![[r#"
-.a_file
-.b_file
 a_file
 b_file
-.c_dir/
-.d_dir/
 c_dir/
 d_dir/
 -	stdio
@@ -600,12 +588,8 @@ d_dir/
     assert_data_eq!(
         complete!(cmd, "--input .[TAB]", current_dir = Some(testdir_path)),
         snapbox::str![[r#"
-./.a_file
-./.b_file
 ./a_file
 ./b_file
-./.c_dir/
-./.d_dir/
 ./c_dir/
 ./d_dir/
 "#]],
@@ -645,8 +629,6 @@ fn suggest_value_path_dir() {
         complete!(cmd, "--input [TAB]", current_dir = Some(testdir_path)),
         snapbox::str![[r#"
 .
-.c_dir/
-.d_dir/
 c_dir/
 d_dir/
 "#]],
@@ -659,8 +641,6 @@ d_dir/
     assert_data_eq!(
         complete!(cmd, "--input .[TAB]", current_dir = Some(testdir_path)),
         snapbox::str![[r#"
-./.c_dir/
-./.d_dir/
 ./c_dir/
 ./d_dir/
 "#]],
