refactor(builder): Consolidate escaping with Escape

Author: yash27-lab

clap_builder/src/builder/possible_value.rs

@@ -2,6 +2,8 @@ use crate::builder::IntoResettable;
 use crate::builder::Str;
 use crate::builder::StyledStr;
 use crate::util::eq_ignore_case;
+#[cfg(feature = "help")]
+use crate::util::Escape;
 
 /// A possible value of an argument.
 ///
@@ -186,11 +188,7 @@ impl PossibleValue {
     #[cfg(feature = "help")]
     pub(crate) fn get_visible_quoted_name(&self) -> Option<std::borrow::Cow<'_, str>> {
         if !self.hide {
-            Some(if self.name.contains(char::is_whitespace) {
-                format!("{:?}", self.name).into()
-            } else {
-                self.name.as_str().into()
-            })
+            Some(Escape(self.name.as_str()).to_cow())
         } else {
             None
         }

clap_builder/src/error/format.rs

@@ -14,6 +14,7 @@ use crate::error::ContextKind;
 use crate::error::ContextValue;
 use crate::error::ErrorKind;
 use crate::output::TAB;
+use crate::util::Escape;
 use crate::ArgAction;
 
 /// Defines how to format an error for displaying to the user
@@ -491,15 +492,3 @@ fn did_you_mean(styled: &mut StyledStr, styles: &Styles, context: &str, possible
         }
     }
 }
-
-struct Escape<'s>(&'s str);
-
-impl std::fmt::Display for Escape<'_> {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        if self.0.contains(char::is_whitespace) {
-            std::fmt::Debug::fmt(self.0, f)
-        } else {
-            self.0.fmt(f)
-        }
-    }
-}

clap_builder/src/output/help_template.rs

@@ -19,6 +19,7 @@ use crate::output::wrap;
 use crate::output::Usage;
 use crate::output::TAB;
 use crate::output::TAB_WIDTH;
+use crate::util::Escape;
 use crate::util::FlatSet;
 
 /// `clap` auto-generated help writer
@@ -795,12 +796,9 @@ impl HelpTemplate<'_, '_> {
                 .default_vals
                 .iter()
                 .map(|dv| dv.to_string_lossy())
-                .map(|dv| {
-                    if dv.contains(char::is_whitespace) {
-                        Cow::from(format!("{dv:?}"))
-                    } else {
-                        dv
-                    }
+                .map(|dv| match Escape(dv.as_ref()).to_cow() {
+                    Cow::Borrowed(_) => dv,
+                    Cow::Owned(escaped) => Cow::Owned(escaped),
                 })
                 .collect::<Vec<_>>()
                 .join(" ");

clap_builder/src/util/escape.rs

@@ -0,0 +1,29 @@
+#[cfg(feature = "help")]
+use std::borrow::Cow;
+
+pub(crate) struct Escape<'s>(pub(crate) &'s str);
+
+impl<'s> Escape<'s> {
+    pub(crate) fn needs_escaping(&self) -> bool {
+        self.0.contains(char::is_whitespace)
+    }
+
+    #[cfg(feature = "help")]
+    pub(crate) fn to_cow(&self) -> Cow<'s, str> {
+        if self.needs_escaping() {
+            Cow::Owned(format!("{:?}", self.0))
+        } else {
+            Cow::Borrowed(self.0)
+        }
+    }
+}
+
+impl std::fmt::Display for Escape<'_> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        if self.needs_escaping() {
+            std::fmt::Debug::fmt(self.0, f)
+        } else {
+            self.0.fmt(f)
+        }
+    }
+}

clap_builder/src/util/mod.rs

@@ -1,6 +1,7 @@
 #![allow(clippy::single_component_path_imports)]
 
 mod any_value;
+mod escape;
 pub(crate) mod flat_map;
 pub(crate) mod flat_set;
 mod graph;
@@ -11,6 +12,7 @@ pub use self::id::Id;
 
 pub(crate) use self::any_value::AnyValue;
 pub(crate) use self::any_value::AnyValueId;
+pub(crate) use self::escape::Escape;
 pub(crate) use self::flat_map::Entry;
 pub(crate) use self::flat_map::FlatMap;
 pub(crate) use self::flat_set::FlatSet;