feat(choose): --selected="*" to select all (#769)

close #390 Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
charmbracelet · Dec 12, 2024 · 55120ae · 55120ae
1 parent 774667a
commit 55120ae
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 19 deletions.
diff --git a/choose/command.go b/choose/command.go
@@ -55,6 +55,8 @@ func (o Options) Run() error {
 		slices.SortFunc(o.Options, strings.Compare)
 	}
 
+	isSelectAll := len(o.Selected) == 1 && o.Selected[0] == "*"
+
 	// Keep track of the selected items.
 	currentSelected := 0
 	// Check if selected items should be used.
@@ -65,7 +67,7 @@ func (o Options) Run() error {
 	for i, option := range o.Options {
 		var order int
 		// Check if the option should be selected.
-		isSelected := hasSelectedItems && currentSelected < o.Limit && slices.Contains(o.Selected, option)
+		isSelected := hasSelectedItems && currentSelected < o.Limit && (isSelectAll || slices.Contains(o.Selected, option))
 		// If the option is selected then increment the current selected count.
 		if isSelected {
 			if o.Limit == 1 {

diff --git a/choose/options.go b/choose/options.go
@@ -8,22 +8,23 @@ import (
 
 // Options is the customization options for the choose command.
 type Options struct {
-	Options           []string      `arg:"" optional:"" help:"Options to choose from."`
-	Limit             int           `help:"Maximum number of options to pick" default:"1" group:"Selection"`
-	NoLimit           bool          `help:"Pick unlimited number of options (ignores limit)" group:"Selection"`
-	Ordered           bool          `help:"Maintain the order of the selected options" env:"GUM_CHOOSE_ORDERED"`
-	Height            int           `help:"Height of the list" default:"10" env:"GUM_CHOOSE_HEIGHT"`
-	Cursor            string        `help:"Prefix to show on item that corresponds to the cursor position" default:"> " env:"GUM_CHOOSE_CURSOR"`
-	ShowHelp          bool          `help:"Show help keybinds" default:"true" negatable:"" env:"GUM_CHOOSE_SHOW_HELP"`
-	Header            string        `help:"Header value" default:"Choose:" env:"GUM_CHOOSE_HEADER"`
-	CursorPrefix      string        `help:"Prefix to show on the cursor item (hidden if limit is 1)" default:"• " env:"GUM_CHOOSE_CURSOR_PREFIX"`
-	SelectedPrefix    string        `help:"Prefix to show on selected items (hidden if limit is 1)" default:"✓ " env:"GUM_CHOOSE_SELECTED_PREFIX"`
-	UnselectedPrefix  string        `help:"Prefix to show on unselected items (hidden if limit is 1)" default:"• " env:"GUM_CHOOSE_UNSELECTED_PREFIX"`
-	Selected          []string      `help:"Options that should start as selected" default:"" env:"GUM_CHOOSE_SELECTED"`
-	SelectIfOne       bool          `help:"Select the given option if there is only one" group:"Selection"`
-	CursorStyle       style.Styles  `embed:"" prefix:"cursor." set:"defaultForeground=212" envprefix:"GUM_CHOOSE_CURSOR_"`
-	HeaderStyle       style.Styles  `embed:"" prefix:"header." set:"defaultForeground=99" envprefix:"GUM_CHOOSE_HEADER_"`
-	ItemStyle         style.Styles  `embed:"" prefix:"item." hidden:"" envprefix:"GUM_CHOOSE_ITEM_"`
-	SelectedItemStyle style.Styles  `embed:"" prefix:"selected." set:"defaultForeground=212" envprefix:"GUM_CHOOSE_SELECTED_"`
-	Timeout           time.Duration `help:"Timeout until choose returns selected element" default:"0s" env:"GUM_CCHOOSE_TIMEOUT"` // including timeout command options [Timeout,...]
+	Options          []string      `arg:"" optional:"" help:"Options to choose from."`
+	Limit            int           `help:"Maximum number of options to pick" default:"1" group:"Selection"`
+	NoLimit          bool          `help:"Pick unlimited number of options (ignores limit)" group:"Selection"`
+	Ordered          bool          `help:"Maintain the order of the selected options" env:"GUM_CHOOSE_ORDERED"`
+	Height           int           `help:"Height of the list" default:"10" env:"GUM_CHOOSE_HEIGHT"`
+	Cursor           string        `help:"Prefix to show on item that corresponds to the cursor position" default:"> " env:"GUM_CHOOSE_CURSOR"`
+	ShowHelp         bool          `help:"Show help keybinds" default:"true" negatable:"" env:"GUM_CHOOSE_SHOW_HELP"`
+	Timeout          time.Duration `help:"Timeout until choose returns selected element" default:"0s" env:"GUM_CCHOOSE_TIMEOUT"` // including timeout command options [Timeout,...]
+	Header           string        `help:"Header value" default:"Choose:" env:"GUM_CHOOSE_HEADER"`
+	CursorPrefix     string        `help:"Prefix to show on the cursor item (hidden if limit is 1)" default:"• " env:"GUM_CHOOSE_CURSOR_PREFIX"`
+	SelectedPrefix   string        `help:"Prefix to show on selected items (hidden if limit is 1)" default:"✓ " env:"GUM_CHOOSE_SELECTED_PREFIX"`
+	UnselectedPrefix string        `help:"Prefix to show on unselected items (hidden if limit is 1)" default:"• " env:"GUM_CHOOSE_UNSELECTED_PREFIX"`
+	Selected         []string      `help:"Options that should start as selected (selects all if given '*')" default:"" env:"GUM_CHOOSE_SELECTED"`
+	SelectIfOne      bool          `help:"Select the given option if there is only one" group:"Selection"`
+
+	CursorStyle       style.Styles `embed:"" prefix:"cursor." set:"defaultForeground=212" envprefix:"GUM_CHOOSE_CURSOR_"`
+	HeaderStyle       style.Styles `embed:"" prefix:"header." set:"defaultForeground=99" envprefix:"GUM_CHOOSE_HEADER_"`
+	ItemStyle         style.Styles `embed:"" prefix:"item." hidden:"" envprefix:"GUM_CHOOSE_ITEM_"`
+	SelectedItemStyle style.Styles `embed:"" prefix:"selected." set:"defaultForeground=212" envprefix:"GUM_CHOOSE_SELECTED_"`
 }