completion: display descriptions next to choices

Use go-opt v2 new completion API which returns items descriptions along
with their text values.

Display the descriptions after the items separated by two spaces. Wrap
the descriptions in parentheses to better indicate that they are not
part of the completion choices. Limit the description length to 80
characters to avoid display issues.

Add a new style object completion_description in stylesets. By default,
the object will be rendered with a dimmed terminal attribute. Update all
stylesets and documentation accordingly.

Implements: https://todo.sr.ht/~rjarry/aerc/271
Link: https://git.sr.ht/~rjarry/go-opt/commit/ebeb82538395a
Changelog-added: Command completion now displays descriptions next
 to completion items.
Changelog-added: New `completion_description` style object in style
 sets used for rendering completion item descriptions.
Signed-off-by: Robin Jarry <robin@jarry.cc>
Tested-by: Bojan Gabric <bojan@bojangabric.com>
Tested-by: Jason Cox <me@jasoncarloscox.com>
Acked-by: Tim Culverhouse <tim@timculverhouse.com>

4 files changed, 16 insertions, 16 deletions

diff --git a/app/aerc.go b/app/aerc.go
index 107fc1f3..72a60562 100644
--- a/app/aerc.go
+++ b/app/aerc.go
@@ -11,7 +11,7 @@ import (
 	"time"
 	"unicode"
 
-	"git.sr.ht/~rjarry/go-opt"
+	"git.sr.ht/~rjarry/go-opt/v2"
 	"git.sr.ht/~rockorager/vaxis"
 	"github.com/ProtonMail/go-crypto/openpgp"
 	"github.com/emersion/go-message/mail"
@@ -29,7 +29,7 @@ type Aerc struct {
 	accounts    map[string]*AccountView
 	cmd         func(string, *config.AccountConfig, *models.MessageInfo) error
 	cmdHistory  lib.History
-	complete    func(cmd string) ([]string, string)
+	complete    func(cmd string) ([]opt.Completion, string)
 	focused     ui.Interactive
 	grid        *ui.Grid
 	simulating  int
@@ -54,7 +54,7 @@ type Choice struct {
 func (aerc *Aerc) Init(
 	crypto crypto.Provider,
 	cmd func(string, *config.AccountConfig, *models.MessageInfo) error,
-	complete func(cmd string) ([]string, string), cmdHistory lib.History,
+	complete func(cmd string) ([]opt.Completion, string), cmdHistory lib.History,
 	deferLoop chan struct{},
 ) {
 	tabs := ui.NewTabs(func(d ui.Drawable) *config.UIConfig {
@@ -317,7 +317,7 @@ func (aerc *Aerc) simulate(strokes []config.KeyStroke) {
 	aerc.simulating -= 1
 	if exline, ok := aerc.focused.(*ExLine); ok {
 		// we are still focused on the exline, turn on tab complete
-		exline.TabComplete(func(cmd string) ([]string, string) {
+		exline.TabComplete(func(cmd string) ([]opt.Completion, string) {
 			return aerc.complete(cmd)
 		})
 		if complete {
@@ -633,14 +633,12 @@ func (aerc *Aerc) focus(item ui.Interactive) {
 
 func (aerc *Aerc) BeginExCommand(cmd string) {
 	previous := aerc.focused
-	var tabComplete func(string) ([]string, string)
+	var tabComplete func(string) ([]opt.Completion, string)
 	if aerc.simulating != 0 {
 		// Don't try to draw completions for simulated events
 		tabComplete = nil
 	} else {
-		tabComplete = func(cmd string) ([]string, string) {
-			return aerc.complete(cmd)
-		}
+		tabComplete = aerc.complete
 	}
 	exline := NewExLine(cmd, func(cmd string) {
 		err := aerc.cmd(cmd, nil, nil)
@@ -673,7 +671,7 @@ func (aerc *Aerc) RegisterPrompt(prompt string, cmd string) {
 		if err != nil {
 			aerc.PushError(err.Error())
 		}
-	}, func(cmd string) ([]string, string) {
+	}, func(cmd string) ([]opt.Completion, string) {
 		return nil, "" // TODO: completions
 	})
 	aerc.prompts.Push(p)
@@ -700,7 +698,7 @@ func (aerc *Aerc) RegisterChoices(choices []Choice) {
 		if err != nil {
 			aerc.PushError(err.Error())
 		}
-	}, func(cmd string) ([]string, string) {
+	}, func(cmd string) ([]opt.Completion, string) {
 		return nil, "" // TODO: completions
 	})
 	aerc.prompts.Push(p)
diff --git a/app/app.go b/app/app.go
index 37444c8b..071aac74 100644
--- a/app/app.go
+++ b/app/app.go
@@ -10,6 +10,7 @@ import (
 	"git.sr.ht/~rjarry/aerc/lib/ui"
 	"git.sr.ht/~rjarry/aerc/models"
 	"git.sr.ht/~rjarry/aerc/worker/types"
+	"git.sr.ht/~rjarry/go-opt/v2"
 	"github.com/ProtonMail/go-crypto/openpgp"
 )
 
@@ -18,7 +19,7 @@ var aerc Aerc
 func Init(
 	crypto crypto.Provider,
 	cmd func(string, *config.AccountConfig, *models.MessageInfo) error,
-	complete func(cmd string) ([]string, string), history lib.History,
+	complete func(cmd string) ([]opt.Completion, string), history lib.History,
 	deferLoop chan struct{},
 ) {
 	aerc.Init(crypto, cmd, complete, history, deferLoop)
diff --git a/app/exline.go b/app/exline.go
index e8b0069e..5f8e4280 100644
--- a/app/exline.go
+++ b/app/exline.go
@@ -4,19 +4,20 @@ import (
 	"git.sr.ht/~rjarry/aerc/config"
 	"git.sr.ht/~rjarry/aerc/lib"
 	"git.sr.ht/~rjarry/aerc/lib/ui"
+	"git.sr.ht/~rjarry/go-opt/v2"
 	"git.sr.ht/~rockorager/vaxis"
 )
 
 type ExLine struct {
 	commit      func(cmd string)
 	finish      func()
-	tabcomplete func(cmd string) ([]string, string)
+	tabcomplete func(cmd string) ([]opt.Completion, string)
 	cmdHistory  lib.History
 	input       *ui.TextInput
 }
 
 func NewExLine(cmd string, commit func(cmd string), finish func(),
-	tabcomplete func(cmd string) ([]string, string),
+	tabcomplete func(cmd string) ([]opt.Completion, string),
 	cmdHistory lib.History,
 ) *ExLine {
 	input := ui.NewTextInput("", config.Ui).Prompt(":").Set(cmd)
@@ -38,7 +39,7 @@ func NewExLine(cmd string, commit func(cmd string), finish func(),
 	return exline
 }
 
-func (x *ExLine) TabComplete(tabComplete func(string) ([]string, string)) {
+func (x *ExLine) TabComplete(tabComplete func(string) ([]opt.Completion, string)) {
 	x.input.TabComplete(
 		tabComplete,
 		config.Ui.CompletionDelay,
@@ -48,7 +49,7 @@ func (x *ExLine) TabComplete(tabComplete func(string) ([]string, string)) {
 }
 
 func NewPrompt(prompt string, commit func(text string),
-	tabcomplete func(cmd string) ([]string, string),
+	tabcomplete func(cmd string) ([]opt.Completion, string),
 ) *ExLine {
 	input := ui.NewTextInput("", config.Ui).Prompt(prompt)
 	if config.Ui.CompletionPopovers {
diff --git a/app/msgviewer.go b/app/msgviewer.go
index 0af87e5e..0c2c1bef 100644
--- a/app/msgviewer.go
+++ b/app/msgviewer.go
@@ -23,7 +23,7 @@ import (
 	"git.sr.ht/~rjarry/aerc/lib/parse"
 	"git.sr.ht/~rjarry/aerc/lib/ui"
 	"git.sr.ht/~rjarry/aerc/models"
-	"git.sr.ht/~rjarry/go-opt"
+	"git.sr.ht/~rjarry/go-opt/v2"
 	"git.sr.ht/~rockorager/vaxis"
 	"git.sr.ht/~rockorager/vaxis/widgets/align"