Merge pull request #6131 from mernen/do-not-suggest-opts-after-escape

fix(complete): do not suggest options after escape (`--`)

Author: epage

clap_complete/src/engine/complete.rs

@@ -47,7 +47,14 @@ pub fn complete(
             arg.to_value_os(),
         );
         if cursor == target_cursor {
-            return complete_arg(&arg, current_cmd, current_dir, pos_index, current_state);
+            return complete_arg(
+                &arg,
+                current_cmd,
+                current_dir,
+                pos_index,
+                is_escaped,
+                current_state,
+            );
         }
 
         if let Ok(value) = arg.to_value() {
@@ -133,6 +140,7 @@ fn complete_arg(
     cmd: &clap::Command,
     current_dir: Option<&std::path::Path>,
     pos_index: usize,
+    is_escaped: bool,
     state: ParseState<'_>,
 ) -> Result<Vec<CompletionCandidate>, std::io::Error> {
     debug!(
@@ -157,7 +165,9 @@ fn complete_arg(
             {
                 completions.extend(complete_arg_value(arg.to_value(), positional, current_dir));
             }
-            completions.extend(complete_option(arg, cmd, current_dir));
+            if !is_escaped {
+                completions.extend(complete_option(arg, cmd, current_dir));
+            }
         }
         ParseState::Pos((_, num_arg)) => {
             if let Some(positional) = cmd
@@ -183,6 +193,7 @@ fn complete_arg(
                     cmd,
                     current_dir,
                     pos_index,
+                    is_escaped,
                     ParseState::ValueDone,
                 )?);
             }

clap_complete/tests/testsuite/engine.rs

@@ -263,6 +263,26 @@ goodbye-world
     );
 }
 
+#[test]
+fn suggest_subcommand_positional_after_escape() {
+    let mut cmd = Command::new("exhaustive").subcommand(Command::new("hello-world").arg(
+        clap::Arg::new("hello-world").value_parser([
+            PossibleValue::new("hello-world").help("Say hello to the world"),
+            "hello-moon".into(),
+            "goodbye-world".into(),
+        ]),
+    ));
+
+    assert_data_eq!(
+        complete!(cmd, "hello-world -- [TAB]"),
+        snapbox::str![[r#"
+hello-world	Say hello to the world
+hello-moon
+goodbye-world
+"#]],
+    );
+}
+
 #[test]
 fn suggest_argument_value() {
     let mut cmd = Command::new("dynamic")
@@ -1034,8 +1054,6 @@ comma,tab
 a_pos
 b_pos
 c_pos
---delimiter
---help	Print help
 "#]]
     );