refactor(error): Give caller control over suggestion

clap-rs · Aug 16, 2023 · 13e3770 · 13e3770
1 parent 8413c15
commit 13e3770
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/clap_builder/src/error/mod.rs b/clap_builder/src/error/mod.rs
@@ -718,7 +718,7 @@ impl<F: ErrorFormatter> Error<F> {
                     let mut styled_suggestion = StyledStr::new();
                     let _ = write!(
                         styled_suggestion,
-                        "'{}{sub} --{flag}{}' exists",
+                        "'{}{sub} {flag}{}' exists",
                         valid.render(),
                         valid.render_reset()
                     );
@@ -727,7 +727,7 @@ impl<F: ErrorFormatter> Error<F> {
                 Some((flag, None)) => {
                     err = err.insert_context_unchecked(
                         ContextKind::SuggestedArg,
-                        ContextValue::String(format!("--{flag}")),
+                        ContextValue::String(flag),
                     );
                 }
                 None => {}

diff --git a/clap_builder/src/parser/parser.rs b/clap_builder/src/parser/parser.rs
@@ -1521,6 +1521,7 @@ impl<'cmd> Parser<'cmd> {
                 self.start_custom_arg(matcher, arg, ValueSource::CommandLine);
             }
         }
+        let did_you_mean = did_you_mean.map(|(arg, cmd)| (format!("--{arg}"), cmd));
 
         let required = self.cmd.required_graph();
         let used: Vec<Id> = matcher

diff --git a/tests/builder/error.rs b/tests/builder/error.rs
@@ -229,7 +229,7 @@ fn unknown_argument_option() {
     static MESSAGE: &str = "\
 error: unexpected argument '--cwd <current-dir-unknown>' found
 
-  tip: a similar argument exists: '---C'
+  tip: a similar argument exists: '-C'
 
 Usage: test [OPTIONS]
 
@@ -259,7 +259,7 @@ fn unknown_argument_flag() {
     static MESSAGE: &str = "\
 error: unexpected argument '--ignored' found
 
-  tip: a similar argument exists: '---- --ignored'
+  tip: a similar argument exists: '-- --ignored'
 
 Usage: test [OPTIONS]