zsh: usage support

initial version without the `read` variant and formatting

Co-authored-by: maxlandon <maximelandon@gmail.com>

example/cmd/_test/zsh.sh

@@ -15,9 +15,10 @@ function _example_completion {
   fi
 
   export ZLS_COLOURS="${lines[1]}"
+  [[ ! "${lines[2]}" == "NONE" ]] && _message -r "${lines[2]}"
 
   # shellcheck disable=SC2034,2206
-  lines=(${lines[@]:1})
+  lines=(${lines[@]:2})
   # shellcheck disable=SC2034,2206
   local vals=(${lines%$'\t'*})
   # shellcheck disable=SC2034,2206

internal/shell/zsh/action.go

@@ -93,7 +93,8 @@ func ActionRawValues(currentWord string, usage string, nospace common.SuffixMatc
 	if len(zstyles) > 1000 { // TODO disable styling for large amount of values (bad performance)
 		zstyles = make([]string, 0)
 	}
-	return fmt.Sprintf(":%v\n%v", strings.Join(zstyles, ":"), strings.Join(vals, "\n"))
+
+	return fmt.Sprintf(":%v\n%v\n%v", strings.Join(zstyles, ":"), santizeMessage(usage), strings.Join(vals, "\n"))
 }
 
 var zstyleQuoter = strings.NewReplacer(
@@ -113,3 +114,19 @@ var zstyleQuoter = strings.NewReplacer(
 func formatZstyle(s, _styleValue, _styleDescription string) string {
 	return fmt.Sprintf("=(#b)%v=0=%v=%v=%v", s, style.SGR(_styleValue), style.SGR(_styleDescription+" bg-default"), style.SGR(_styleDescription))
 }
+
+func santizeMessage(s string) string { // TODO cleanup
+	s = strings.NewReplacer(
+		"\n", ``,
+		"\r", ``,
+		"\t", ``,
+		"\v", ``,
+		"\f", ``,
+		"\b", ``,
+	).Replace(s)
+
+	if s == "" {
+		return "NONE" // TODO fix empty line issue in script
+	}
+	return s
+}

internal/shell/zsh/snippet.go

@@ -27,9 +27,10 @@ function _%v_completion {
   fi
 
   export ZLS_COLOURS="${lines[1]}"
+  [[ ! "${lines[2]}" == "NONE" ]] && _message -r "${lines[2]}"
   
   # shellcheck disable=SC2034,2206
-  lines=(${lines[@]:1})
+  lines=(${lines[@]:2})
   # shellcheck disable=SC2034,2206
   local vals=(${lines%%$'\t'*})
   # shellcheck disable=SC2034,2206