Merge pull request #6104 from epage/hide

fix(complete): Hide dot files on dynamic completer

Author: epage

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) {

clap_complete/tests/testsuite/engine.rs

@@ -506,9 +506,13 @@ fn suggest_value_hint_file_path() {
     let testdir_path = testdir.path().unwrap();
 
     fs::write(testdir_path.join("a_file"), "").unwrap();
+    fs::write(testdir_path.join(".a_file"), "").unwrap();
     fs::write(testdir_path.join("b_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(".c_dir")).unwrap();
     fs::create_dir_all(testdir_path.join("d_dir")).unwrap();
+    fs::create_dir_all(testdir_path.join(".d_dir")).unwrap();
 
     assert_data_eq!(
         complete!(cmd, "--input [TAB]", current_dir = Some(testdir_path)),
@@ -524,16 +528,34 @@ d_dir/
         complete!(cmd, "--input a[TAB]", current_dir = Some(testdir_path)),
         snapbox::str!["a_file"],
     );
+    assert_data_eq!(
+        complete!(cmd, "--input .[TAB]", current_dir = Some(testdir_path)),
+        snapbox::str![[r#"
+./a_file
+./b_file
+./c_dir/
+./d_dir/
+"#]],
+    );
+    assert_data_eq!(
+        complete!(cmd, "--input .a[TAB]", current_dir = Some(testdir_path)),
+        snapbox::str![".a_file"],
+    );
 }
 
 #[test]
 fn suggest_value_path_file() {
     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(".a_file"), "").unwrap();
     fs::write(testdir_path.join("b_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(".c_dir")).unwrap();
     fs::create_dir_all(testdir_path.join("d_dir")).unwrap();
+    fs::create_dir_all(testdir_path.join(".d_dir")).unwrap();
 
     let mut cmd = Command::new("dynamic")
         .arg(
@@ -563,16 +585,34 @@ d_dir/
         complete!(cmd, "--input a[TAB]", current_dir = Some(testdir_path)),
         snapbox::str!["a_file"],
     );
+    assert_data_eq!(
+        complete!(cmd, "--input .[TAB]", current_dir = Some(testdir_path)),
+        snapbox::str![[r#"
+./a_file
+./b_file
+./c_dir/
+./d_dir/
+"#]],
+    );
+    assert_data_eq!(
+        complete!(cmd, "--input .a[TAB]", current_dir = Some(testdir_path)),
+        snapbox::str![".a_file"],
+    );
 }
 
 #[test]
 fn suggest_value_path_dir() {
     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(".a_file"), "").unwrap();
     fs::write(testdir_path.join("b_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(".c_dir")).unwrap();
     fs::create_dir_all(testdir_path.join("d_dir")).unwrap();
+    fs::create_dir_all(testdir_path.join(".d_dir")).unwrap();
 
     let mut cmd = Command::new("dynamic")
         .arg(
@@ -598,6 +638,17 @@ d_dir/
         complete!(cmd, "--input c[TAB]", current_dir = Some(testdir_path)),
         snapbox::str!["c_dir/"],
     );
+    assert_data_eq!(
+        complete!(cmd, "--input .[TAB]", current_dir = Some(testdir_path)),
+        snapbox::str![[r#"
+./c_dir/
+./d_dir/
+"#]],
+    );
+    assert_data_eq!(
+        complete!(cmd, "--input .c[TAB]", current_dir = Some(testdir_path)),
+        snapbox::str![".c_dir/"],
+    );
 }
 
 #[test]