From c48ff32c70eb0ae07b3d7b5c83112427073eb350 Mon Sep 17 00:00:00 2001
From: rsteube <rsteube@users.noreply.github.com>
Date: Fri, 29 Dec 2023 20:41:10 +0100
Subject: [PATCH] suggestion: added style

---
 src/completion/base.rs     |  4 ++++
 src/completion/default.rs  | 22 +++++++++++++---------
 src/completion/history.rs  |  1 +
 src/menu/columnar_menu.rs  | 24 +++++++++++++++++-------
 src/menu/menu_functions.rs |  2 ++
 5 files changed, 37 insertions(+), 16 deletions(-)

diff --git a/src/completion/base.rs b/src/completion/base.rs
index 3de63c8d..ed4be1c6 100644
--- a/src/completion/base.rs
+++ b/src/completion/base.rs
@@ -1,3 +1,5 @@
+use nu_ansi_term::Style;
+
 /// A span of source code, with positions in bytes
 #[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Hash)]
 pub struct Span {
@@ -60,6 +62,8 @@ pub struct Suggestion {
     pub value: String,
     /// Optional description for the replacement
     pub description: Option<String>,
+    /// Optional style for the value
+    pub style: Option<Style>,
     /// Optional vector of strings in the suggestion. These can be used to
     /// represent examples coming from a suggestion
     pub extra: Option<Vec<String>>,
diff --git a/src/completion/default.rs b/src/completion/default.rs
index 11062d7b..693885b9 100644
--- a/src/completion/default.rs
+++ b/src/completion/default.rs
@@ -55,17 +55,17 @@ impl Completer for DefaultCompleter {
     /// assert_eq!(
     ///     completions.complete("bat",3),
     ///     vec![
-    ///         Suggestion {value: "batcave".into(), description: None, extra: None, span: Span { start: 0, end: 3 }, append_whitespace: false},
-    ///         Suggestion {value: "batman".into(), description: None, extra: None, span: Span { start: 0, end: 3 }, append_whitespace: false},
-    ///         Suggestion {value: "batmobile".into(), description: None, extra: None, span: Span { start: 0, end: 3 }, append_whitespace: false},
+    ///         Suggestion {value: "batcave".into(), description: None, style: None, extra: None, span: Span { start: 0, end: 3 }, append_whitespace: false},
+    ///         Suggestion {value: "batman".into(), description: None, style: None, extra: None, span: Span { start: 0, end: 3 }, append_whitespace: false},
+    ///         Suggestion {value: "batmobile".into(), description: None, style: None, extra: None, span: Span { start: 0, end: 3 }, append_whitespace: false},
     ///     ]);
     ///
     /// assert_eq!(
     ///     completions.complete("to the bat",10),
     ///     vec![
-    ///         Suggestion {value: "batcave".into(), description: None, extra: None, span: Span { start: 7, end: 10 }, append_whitespace: false},
-    ///         Suggestion {value: "batman".into(), description: None, extra: None, span: Span { start: 7, end: 10 }, append_whitespace: false},
-    ///         Suggestion {value: "batmobile".into(), description: None, extra: None, span: Span { start: 7, end: 10 }, append_whitespace: false},
+    ///         Suggestion {value: "batcave".into(), description: None, style: None, extra: None, span: Span { start: 7, end: 10 }, append_whitespace: false},
+    ///         Suggestion {value: "batman".into(), description: None, style: None, extra: None, span: Span { start: 7, end: 10 }, append_whitespace: false},
+    ///         Suggestion {value: "batmobile".into(), description: None, style: None, extra: None, span: Span { start: 7, end: 10 }, append_whitespace: false},
     ///     ]);
     /// ```
     fn complete(&mut self, line: &str, pos: usize) -> Vec<Suggestion> {
@@ -99,6 +99,7 @@ impl Completer for DefaultCompleter {
                                     Suggestion {
                                         value: format!("{span_line}{ext}"),
                                         description: None,
+                                        style: None,
                                         extra: None,
                                         span,
                                         append_whitespace: false,
@@ -173,15 +174,15 @@ impl DefaultCompleter {
     /// completions.insert(vec!["test-hyphen","test_underscore"].iter().map(|s| s.to_string()).collect());
     /// assert_eq!(
     ///     completions.complete("te",2),
-    ///     vec![Suggestion {value: "test".into(), description: None, extra: None, span: Span { start: 0, end: 2 }, append_whitespace: false}]);
+    ///     vec![Suggestion {value: "test".into(), description: None, style: None, extra: None, span: Span { start: 0, end: 2 }, append_whitespace: false}]);
     ///
     /// let mut completions = DefaultCompleter::with_inclusions(&['-', '_']);
     /// completions.insert(vec!["test-hyphen","test_underscore"].iter().map(|s| s.to_string()).collect());
     /// assert_eq!(
     ///     completions.complete("te",2),
     ///     vec![
-    ///         Suggestion {value: "test-hyphen".into(), description: None, extra: None, span: Span { start: 0, end: 2 }, append_whitespace: false},
-    ///         Suggestion {value: "test_underscore".into(), description: None, extra: None, span: Span { start: 0, end: 2 }, append_whitespace: false},
+    ///         Suggestion {value: "test-hyphen".into(), description: None, style: None, extra: None, span: Span { start: 0, end: 2 }, append_whitespace: false},
+    ///         Suggestion {value: "test_underscore".into(), description: None, style: None, extra: None, span: Span { start: 0, end: 2 }, append_whitespace: false},
     ///     ]);
     /// ```
     pub fn with_inclusions(incl: &[char]) -> Self {
@@ -371,6 +372,7 @@ mod tests {
                 Suggestion {
                     value: "ｎｕｌｌ".into(),
                     description: None,
+                    style: None,
                     extra: None,
                     span: Span { start: 0, end: 3 },
                     append_whitespace: false,
@@ -378,6 +380,7 @@ mod tests {
                 Suggestion {
                     value: "ｎｕｍｂｅｒ".into(),
                     description: None,
+                    style: None,
                     extra: None,
                     span: Span { start: 0, end: 3 },
                     append_whitespace: false,
@@ -385,6 +388,7 @@ mod tests {
                 Suggestion {
                     value: "ｎｕｓｈｅｌｌ".into(),
                     description: None,
+                    style: None,
                     extra: None,
                     span: Span { start: 0, end: 3 },
                     append_whitespace: false,
diff --git a/src/completion/history.rs b/src/completion/history.rs
index ea6aedb6..82c6a89b 100644
--- a/src/completion/history.rs
+++ b/src/completion/history.rs
@@ -59,6 +59,7 @@ impl<'menu> HistoryCompleter<'menu> {
         Suggestion {
             value: value.to_string(),
             description: None,
+            style: None,
             extra: None,
             span,
             append_whitespace: false,
diff --git a/src/menu/columnar_menu.rs b/src/menu/columnar_menu.rs
index ec391777..c9efb3b2 100644
--- a/src/menu/columnar_menu.rs
+++ b/src/menu/columnar_menu.rs
@@ -344,9 +344,14 @@ impl ColumnarMenu {
                     let left_text_size = self.longest_suggestion + self.default_details.col_padding;
                     let right_text_size = self.get_width().saturating_sub(left_text_size);
                     format!(
-                        "{}{:max$}{}{}{}",
-                        self.color.selected_text_style.prefix(),
+                        "{}{:max$}{}{}{}{}",
+                        suggestion
+                            .style
+                            .unwrap_or(self.color.text_style)
+                            .reverse() // TODO support selected_text_style
+                            .prefix(),
                         &suggestion.value,
+                        self.color.description_style.reverse().prefix(),
                         description
                             .chars()
                             .take(right_text_size)
@@ -359,7 +364,11 @@ impl ColumnarMenu {
                 } else {
                     format!(
                         "{}{}{}{:>empty$}{}",
-                        self.color.selected_text_style.prefix(),
+                        suggestion
+                            .style
+                            .unwrap_or(self.color.text_style)
+                            .reverse() // TODO support selected_text_style
+                            .prefix(),
                         &suggestion.value,
                         RESET,
                         "",
@@ -372,9 +381,9 @@ impl ColumnarMenu {
                 let right_text_size = self.get_width().saturating_sub(left_text_size);
                 format!(
                     "{}{:max$}{}{}{}{}{}",
-                    self.color.text_style.prefix(),
+                    suggestion.style.unwrap_or(self.color.text_style).prefix(),
                     &suggestion.value,
-                    RESET,
+                    RESET, // TODO affects space suffix of value
                     self.color.description_style.prefix(),
                     description
                         .chars()
@@ -388,9 +397,9 @@ impl ColumnarMenu {
             } else {
                 format!(
                     "{}{}{}{}{:>empty$}{}{}",
-                    self.color.text_style.prefix(),
+                    suggestion.style.unwrap_or(self.color.text_style).prefix(),
                     &suggestion.value,
-                    RESET,
+                    RESET, // TODO affects space suffix of value
                     self.color.description_style.prefix(),
                     "",
                     RESET,
@@ -806,6 +815,7 @@ mod tests {
         Suggestion {
             value: name.to_string(),
             description: None,
+            style: None,
             extra: None,
             span: Span { start: 0, end: pos },
             append_whitespace: false,
diff --git a/src/menu/menu_functions.rs b/src/menu/menu_functions.rs
index 8d15d696..b381fa36 100644
--- a/src/menu/menu_functions.rs
+++ b/src/menu/menu_functions.rs
@@ -488,6 +488,7 @@ mod tests {
             .map(|s| Suggestion {
                 value: s.into(),
                 description: None,
+                style: None,
                 extra: None,
                 span: Span::new(0, s.len()),
                 append_whitespace: false,
@@ -507,6 +508,7 @@ mod tests {
             .map(|s| Suggestion {
                 value: s.into(),
                 description: None,
+                style: None,
                 extra: None,
                 span: Span::new(0, s.len()),
                 append_whitespace: false,