From 387d7d2243c1378ccd59fb77e7dd767870feb662 Mon Sep 17 00:00:00 2001
From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com>
Date: Tue, 26 Jul 2022 19:24:02 -0400
Subject: [PATCH] fix: percentages in completion entries causing a problem in
 the completion menus

---
 CHANGELOG.md           | 2 ++
 readline/comp-grid.go  | 4 ++--
 readline/comp-group.go | 6 ++++++
 readline/comp-list.go  | 4 ++--
 readline/comp-map.go   | 4 ++--
 5 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 522c8d5..48d54f2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -138,6 +138,8 @@ menu is open.
   - `hilbish.dataDir` now has tilde (`~`) expanded.
   - Arrow keys now work on Windows terminals.
   - Escape codes now work.
+- Escape percentage symbols in completion entries, so you will no longer see
+an error of missing format variable
 
 ## [1.2.0] - 2022-03-17
 ### Added
diff --git a/readline/comp-grid.go b/readline/comp-grid.go
index 2679835..48a2039 100644
--- a/readline/comp-grid.go
+++ b/readline/comp-grid.go
@@ -99,7 +99,7 @@ func (g *CompletionGroup) writeGrid(rl *Instance) (comp string) {
 
 	// If group title, print it and adjust offset.
 	if g.Name != "" {
-		comp += fmt.Sprintf("%s%s%s %s\n", BOLD, YELLOW, g.Name, RESET)
+		comp += fmt.Sprintf("%s%s%s %s\n", BOLD, YELLOW, fmtEscape(g.Name), RESET)
 		rl.tcUsedY++
 	}
 
@@ -124,7 +124,7 @@ func (g *CompletionGroup) writeGrid(rl *Instance) (comp string) {
 			comp += seqInvert
 		}
 
-		comp += fmt.Sprintf("%-"+cellWidth+"s %s", g.Suggestions[i], seqReset)
+		comp += fmt.Sprintf("%-"+cellWidth+"s %s", fmtEscape(g.Suggestions[i]), seqReset)
 	}
 
 	// Always add a newline to the group if the end if not punctuated with one
diff --git a/readline/comp-group.go b/readline/comp-group.go
index 6a6e7bc..0c53ed1 100644
--- a/readline/comp-group.go
+++ b/readline/comp-group.go
@@ -1,5 +1,7 @@
 package readline
 
+import "strings"
+
 // CompletionGroup - A group/category of items offered to completion, with its own
 // name, descriptions and completion display format/type.
 // The output, if there are multiple groups available for a given completion input,
@@ -285,3 +287,7 @@ func (g *CompletionGroup) goLastCell() {
 		g.tcPosX = 0
 	}
 }
+
+func fmtEscape(s string) string {
+	return strings.Replace(s, "%", "%%", -1)
+}
diff --git a/readline/comp-list.go b/readline/comp-list.go
index 42add2f..cdcda8f 100644
--- a/readline/comp-list.go
+++ b/readline/comp-list.go
@@ -206,12 +206,12 @@ func (g *CompletionGroup) writeList(rl *Instance) (comp string) {
 		if len(item) > maxLength {
 			item = item[:maxLength-3] + "..."
 		}
-		sugg := fmt.Sprintf("\r%s%-"+cellWidth+"s", highlight(y, 0), item)
+		sugg := fmt.Sprintf("\r%s%-"+cellWidth+"s", highlight(y, 0), fmtEscape(item))
 
 		// Alt suggestion
 		alt, ok := g.Aliases[item]
 		if ok {
-			alt = fmt.Sprintf(" %s%"+cellWidthAlt+"s", highlight(y, 1), alt)
+			alt = fmt.Sprintf(" %s%"+cellWidthAlt+"s", highlight(y, 1), fmtEscape(alt))
 		} else {
 			// Else, make an empty cell
 			alt = strings.Repeat(" ", maxLengthAlt+1) // + 2 to keep account of spaces
diff --git a/readline/comp-map.go b/readline/comp-map.go
index 42b56cf..ec985ff 100644
--- a/readline/comp-map.go
+++ b/readline/comp-map.go
@@ -76,7 +76,7 @@ func (g *CompletionGroup) writeMap(rl *Instance) (comp string) {
 
 	if g.Name != "" {
 		// Print group title (changes with line returns depending on type)
-		comp += fmt.Sprintf("%s%s%s %s\n", BOLD, YELLOW, g.Name, RESET)
+		comp += fmt.Sprintf("%s%s%s %s\n", BOLD, YELLOW, fmtEscape(g.Name), RESET)
 		rl.tcUsedY++
 	}
 
@@ -126,7 +126,7 @@ func (g *CompletionGroup) writeMap(rl *Instance) (comp string) {
 		}
 
 		comp += fmt.Sprintf("\r%-"+cellWidth+"s %s %-"+itemWidth+"s %s\n",
-			description, highlight(y), item, seqReset)
+			description, highlight(y), fmtEscape(item), seqReset)
 	}
 
 	// Add the equivalent of this group's size to final screen clearing