implement fuzzy search

Author: koki-develop

fzf.go

@@ -18,7 +18,7 @@ func New(opts ...Option) *FZF {
 }
 
 func (fzf *FZF) Find(items Items) (int, error) {
-	m := newModel(fzf, items)
+	m := newModel(fzf, newItems(items))
 
 	p := tea.NewProgram(m)
 	if _, err := p.Run(); err != nil {

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/charmbracelet/bubbles v0.15.0
 	github.com/charmbracelet/bubbletea v0.23.2
 	github.com/charmbracelet/lipgloss v0.6.0
+	github.com/sahilm/fuzzy v0.1.0
 	github.com/spf13/cobra v1.6.1
 )
 

go.sum

@@ -16,6 +16,7 @@ github.com/containerd/console v1.0.3/go.mod h1:7LqA/THxQ86k76b8c/EMSiaJ3h1eZkMkX
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc=
 github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
@@ -45,6 +46,7 @@ github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJ
 github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/sahilm/fuzzy v0.1.0 h1:FzWGaw2Opqyu+794ZQ9SYifWv2EIXpwP4q8dY1kDAwI=
 github.com/sahilm/fuzzy v0.1.0/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y=
 github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=
 github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUqzrY=

item.go

@@ -4,3 +4,19 @@ type Items interface {
 	ItemString(int) string
 	Len() int
 }
+
+type items struct {
+	items Items
+}
+
+func newItems(is Items) items {
+	return items{is}
+}
+
+func (is items) String(i int) string {
+	return is.items.ItemString(i)
+}
+
+func (is items) Len() int {
+	return is.items.Len()
+}

model.go

@@ -8,6 +8,7 @@ import (
 	"github.com/charmbracelet/bubbles/textinput"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"
+	"github.com/sahilm/fuzzy"
 )
 
 var (
@@ -16,11 +17,12 @@ var (
 
 type model struct {
 	fzf   *FZF
-	items Items
+	items items
 
 	// state
 	abort   bool
 	cursor  int
+	matches fuzzy.Matches
 	choices []int
 
 	// window
@@ -32,7 +34,7 @@ type model struct {
 	input textinput.Model
 }
 
-func newModel(fzf *FZF, items Items) *model {
+func newModel(fzf *FZF, items items) *model {
 	input := textinput.New()
 	input.Prompt = fzf.option.prompt
 	input.Placeholder = fzf.option.inputPlaceholder
@@ -44,6 +46,7 @@ func newModel(fzf *FZF, items Items) *model {
 		// state
 		abort:   false,
 		cursor:  0,
+		matches: fuzzy.Matches{},
 		choices: []int{},
 		// window
 		windowWidth:     0,
@@ -79,7 +82,7 @@ func (m *model) itemsView() string {
 	headerHeight := lipgloss.Height(m.headerView())
 	cursorLen := stringLen(m.fzf.option.cursor)
 
-	for i := 0; i < m.items.Len(); i++ {
+	for i, match := range m.matches {
 		if i < m.windowYPosition {
 			continue
 		}
@@ -92,15 +95,17 @@ func (m *model) itemsView() string {
 		_, _ = v.WriteString(cursor)
 
 		// write item
-		itemstring := m.items.ItemString(i)
 		var itemv strings.Builder
-		for _, c := range itemstring {
-			// cursor line
+		for ci, c := range match.Str {
+			// matches
+			style := lipgloss.NewStyle()
+			if intContains(match.MatchedIndexes, ci) {
+				style = style.Inherit(m.fzf.option.styles.Matches)
+			}
 			if i == m.cursor {
-				_, _ = itemv.WriteString(m.fzf.option.styles.CursorLine.Render(string(c)))
-			} else {
-				itemv.WriteString(string(c))
+				style = style.Inherit(m.fzf.option.styles.CursorLine)
 			}
+			_, _ = itemv.WriteString(style.Render(string(c)))
 		}
 		_, _ = v.WriteString(itemv.String())
 
@@ -151,6 +156,7 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		cmds = append(cmds, cmd)
 	}
 
+	m.filter()
 	m.fixYPosition()
 	m.fixCursor()
 
@@ -164,7 +170,7 @@ func (m *model) choice() {
 	}
 
 	if len(m.choices) == 0 && m.cursor >= 0 {
-		m.choices = append(m.choices, m.cursor)
+		m.choices = append(m.choices, m.matches[m.cursor].Index)
 	}
 }
 
@@ -175,27 +181,45 @@ func (m *model) cursorUp() {
 }
 
 func (m *model) cursorDown() {
-	if m.cursor+1 < m.items.Len() {
+	if m.cursor+1 < len(m.matches) {
 		m.cursor++
 	}
 }
 
+func (m *model) filter() {
+	var matches fuzzy.Matches
+
+	s := m.input.Value()
+	if s == "" {
+		for i := 0; i < m.items.Len(); i++ {
+			matches = append(matches, fuzzy.Match{
+				Str:   m.items.String(i),
+				Index: i,
+			})
+		}
+		m.matches = matches
+		return
+	}
+
+	m.matches = fuzzy.FindFrom(s, m.items)
+}
+
 func (m *model) fixCursor() {
-	if m.cursor < 0 && m.items.Len() > 0 {
+	if m.cursor < 0 && len(m.matches) > 0 {
 		m.cursor = 0
 		return
 	}
 
-	if m.cursor+1 > m.items.Len() {
-		m.cursor = m.items.Len() - 1
+	if m.cursor+1 > len(m.matches) {
+		m.cursor = len(m.matches) - 1
 		return
 	}
 }
 
 func (m *model) fixYPosition() {
 	headerHeight := lipgloss.Height(m.headerView())
 
-	if m.windowHeight-headerHeight > m.items.Len() {
+	if m.windowHeight-headerHeight > len(m.matches) {
 		m.windowYPosition = 0
 		return
 	}

option.go

@@ -11,6 +11,7 @@ var defaultOption = option{
 	inputPlaceholder: "Filter...",
 	styles: &styles{
 		CursorLine: lipgloss.NewStyle().Bold(true),
+		Matches:    lipgloss.NewStyle().Foreground(lipgloss.Color("#00ADD8")),
 	},
 	keymap: &keymap{
 		Up:     key.NewBinding(key.WithKeys("up", "ctrl+p")),
@@ -48,6 +49,9 @@ func WithStyles(ss *Styles) Option {
 		if ss.CursorLine != nil {
 			o.styles.CursorLine = ss.CursorLine.lipgloss()
 		}
+		if ss.Matches != nil {
+			o.styles.Matches = ss.Matches.lipgloss()
+		}
 	}
 }
 

styles.go

@@ -10,10 +10,12 @@ type Style struct {
 
 type Styles struct {
 	CursorLine *Style
+	Matches    *Style
 }
 
 type styles struct {
 	CursorLine lipgloss.Style
+	Matches    lipgloss.Style
 }
 
 func (s *Style) lipgloss() lipgloss.Style {