Add fuzzy usability improvemnts (#7)

- add fuzzy usability improvements
- bump go version to 1.23

cmd/add.go

@@ -8,12 +8,17 @@ import (
 
 // addCmd represents the add command
 var addCmd = &cobra.Command{
-	Use:      "add",
+	Use:      "add [FUZZY_COUNTRY_NAME?]",
 	Short:    "Add one or more clock",
 	PostRunE: saveConfig,
+	Args:     cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		oldNumClocks := len(cfg.ClockCfgs)
-		clockCfgs := ui.SelectClocks()
+		searchTerm := ""
+		if len(args) >= 1 {
+			searchTerm = args[0]
+		}
+		clockCfgs := ui.SelectClocks(searchTerm)
 		cfg.ClockCfgs.Add(clockCfgs...)
 
 		newNumClocks := len(cfg.ClockCfgs)

cmd/root.go

@@ -29,7 +29,7 @@ var (
 
 	cfg     ui.AppConfig
 	rootCmd = &cobra.Command{
-		Use:               "clocks [CLOCK_NAME?]",
+		Use:               "clocks [FUZZY_CLOCK_NAME?]",
 		Short:             "A tool to display time across multiple timezones.",
 		PersistentPreRunE: loadConfig,
 		Args:              cobra.MaximumNArgs(1),
@@ -70,6 +70,23 @@ var (
 				}
 			}
 
+			if len(args) >= 1 {
+				// when a @search term is passed, set layout to horizontal
+				// so that all clocks are displayed in one row
+				// clocks are filtered by the search term
+				// fuzzy search is used to match the search term
+				searchTerm := args[0]
+				cfg.Layout.LayoutType = ui.Horizontal
+
+				n := 0
+				cfg.ClockCfgs, n = cfg.ClockCfgs.Filter(searchTerm)
+				if n == 0 {
+					pterm.FgYellow.Println("No clocks match the search term:", searchTerm)
+					return
+				}
+			}
+
+
 			ui.ShowClocks(cfg)
 		},
 	}

go.mod

@@ -1,6 +1,6 @@
 module github.com/prnvbn/clocks
 
-go 1.21.3
+go 1.23.1
 
 require (
 	github.com/adrg/xdg v0.4.0

internal/match/fuzzy.go

@@ -0,0 +1,11 @@
+package match
+
+import (
+	"strings"
+
+	"github.com/lithammer/fuzzysearch/fuzzy"
+)
+
+func Fuzzy(searchTerm string, toMatch string) bool {
+	return fuzzy.Match(strings.ToLower(searchTerm), strings.ToLower(toMatch))
+}

internal/tmz/filtered.go

@@ -0,0 +1,20 @@
+package tmz
+
+import (
+	"iter"
+
+	"github.com/prnvbn/clocks/internal/match"
+)
+
+func FilteredCountries(searchTerm string) iter.Seq[string] {
+	return func(yield func(string) bool) {
+		for cntry := range CountryZonesMap {
+			if match.Fuzzy(searchTerm, cntry) {
+				if !yield(cntry) {
+					return
+				}
+			}
+		}
+	}
+
+}

internal/ui/config.go

@@ -3,10 +3,12 @@ package ui
 import (
 	"encoding/json"
 	"fmt"
+	"iter"
 	"slices"
 	"strings"
 
-	"github.com/lithammer/fuzzysearch/fuzzy"
+
+	"github.com/prnvbn/clocks/internal/match"
 	"github.com/prnvbn/clocks/internal/tmz"
 )
 
@@ -97,12 +99,19 @@ func (s *SortedClockConfigs) Remove(toRemove ...ClockConfig) {
 }
 
 func (s SortedClockConfigs) Filter(searchTerm string) (filtered SortedClockConfigs, n int) {
-	filtered = make(SortedClockConfigs, 0, len(s))
-	for _, clockCfg := range s {
-		if fuzzy.Match(strings.ToLower(searchTerm), strings.ToLower(clockCfg.Heading)) {
-			filtered = append(filtered, clockCfg)
-			n++
+	filtered = slices.Collect(s.fuzzyFiltered(searchTerm))
+	n = len(filtered)
+	return
+}
+
+func (s SortedClockConfigs) fuzzyFiltered(searchTerm string) iter.Seq[ClockConfig] {
+	return func(yield func(ClockConfig) bool) {
+		for _, clockCfg := range s {
+			if match.Fuzzy(strings.ToLower(searchTerm), strings.ToLower(clockCfg.Heading)) {
+				if !yield(clockCfg) {
+					return
+				}
+			}
 		}
 	}
-	return
 }

internal/ui/select_clocks.go

@@ -7,16 +7,16 @@ import (
 
 	"github.com/prnvbn/clocks/internal/tmz"
 	"github.com/pterm/pterm"
-	"golang.org/x/exp/maps"
 	"golang.org/x/term"
 )
 
 const (
 	minMaxHeight = 5
 )
 
-func SelectClocks() []ClockConfig {
-	cntries := maps.Keys(tmz.CountryZonesMap)
+func SelectClocks(searchTerm string) []ClockConfig {
+	cntries := slices.Collect(tmz.FilteredCountries(searchTerm))
+
 	slices.Sort(cntries)
 
 	cntryMenuHeading := pterm.ThemeDefault.PrimaryStyle.Sprint("Please select countries; you can select the timezones after this ") + pterm.ThemeDefault.SecondaryStyle.Sprint("[type to search]")