README
¶
go-fuzzyfinder
go-fuzzyfinder is a Go library that provides fuzzy-finding with an fzf-like terminal user interface.
Installation
$ go get github.com/ktr0731/go-fuzzyfinder
Usage
go-fuzzyfinder provides two functions, Find and FindMulti.
FindMulti can select multiple lines. It is similar to fzf -m.
This is an example of FindMulti.
type Track struct {
Name string
AlbumName string
Artist string
}
var tracks = []Track{
{"foo", "album1", "artist1"},
{"bar", "album1", "artist1"},
{"foo", "album2", "artist1"},
{"baz", "album2", "artist2"},
{"baz", "album3", "artist2"},
}
func main() {
idx, err := fuzzyfinder.FindMulti(
tracks,
func(i int) string {
return tracks[i].Name
},
fuzzyfinder.WithPreviewWindow(func(i, w, h int) string {
if i == -1 {
return ""
}
return fmt.Sprintf("Track: %s (%s)\nAlbum: %s",
tracks[i].Name,
tracks[i].Artist,
tracks[i].AlbumName)
}))
if err != nil {
log.Fatal(err)
}
fmt.Printf("selected: %v\n", idx)
}
The execution result prints selected item's indexes.
Motivation
Fuzzy-finder command-line tools such that fzf, fzy, or skim are very powerful to find out specified lines interactively. However, there are limits to deal with fuzzy-finder's features in several cases.
First, it is hard to distinguish between two or more entities that have the same text. In the example of ktr0731/itunes-cli, it is possible to conflict tracks such that same track names, but different artists. To avoid such conflicts, we have to display the artist names with each track name. It seems like the problem has been solved, but it still has the problem. It is possible to conflict in case of same track names, same artists, but other albums, which each track belongs to. This problem is difficult to solve because pipes and filters are row-based mechanisms, there are no ways to hold references that point list entities.
The second issue occurs in the case of incorporating a fuzzy-finder as one of the main features in a command-line tool such that enhancd or itunes-cli.
Usually, these tools require that it has been installed one fuzzy-finder as a precondition.
In addition, to deal with the fuzzy-finder, an environment variable configuration such that export TOOL_NAME_FINDER=fzf is required.
It is a bother and complicated.
go-fuzzyfinder resolves above issues.
Dealing with the first issue, go-fuzzyfinder provides the preview-window feature (See an example in Usage).
Also, by using go-fuzzyfinder, built tools don't require any fuzzy-finders.
See Also
Documentation
¶
Overview ¶
Package fuzzyfinder provides terminal user interfaces for fuzzy-finding.
Note that, all functions are not goroutine-safe.
Index ¶
Examples ¶
Constants ¶
const ( // ModeSmart enables a smart matching. It is the default matching mode. // At the beginning, matching mode is ModeCaseInsensitive, but it switches // over to ModeCaseSensitive if an upper case character is inputted. ModeSmart mode = iota // ModeCaseSensitive enables a case-sensitive matching. ModeCaseSensitive // ModeCaseInsensitive enables a case-insensitive matching. ModeCaseInsensitive )
Variables ¶
var ( // ErrAbort is returned from Find* functions if there are no selections. ErrAbort = errors.New("abort") )
Functions ¶
func Find ¶
Find displays a UI that provides fuzzy finding against to the passed slice. The argument slice must be a slice type. If it is not a slice, Find returns an error. itemFunc is called by the length of slice. previewFunc is called when the cursor which points the current selected item is changed. If itemFunc is nil, Find returns an error.
itemFunc receives an argument i. It is the index of the item currently selected.
Find returns ErrAbort if a call of Find is finished with no selection.
Example ¶
package main
import (
"fmt"
fuzzyfinder "github.com/umaumax/go-fuzzyfinder"
)
func main() {
slice := []struct {
id string
name string
}{
{"id1", "foo"},
{"id2", "bar"},
{"id3", "baz"},
}
idx, _ := fuzzyfinder.Find(slice, func(i int) string {
return fmt.Sprintf("[%s] %s", slice[i].id, slice[i].name)
})
fmt.Println(slice[idx]) // The selected item.
}
Output:
Example (PreviewWindow) ¶
package main
import (
"fmt"
fuzzyfinder "github.com/umaumax/go-fuzzyfinder"
)
func main() {
slice := []struct {
id string
name string
}{
{"id1", "foo"},
{"id2", "bar"},
{"id3", "baz"},
}
fuzzyfinder.Find(
slice,
func(i int) string {
return fmt.Sprintf("[%s] %s", slice[i].id, slice[i].name)
},
fuzzyfinder.WithPreviewWindow(func(i, width, _ int) string {
if i == -1 {
return "no results"
}
s := fmt.Sprintf("%s is selected", slice[i].name)
// As an example of using width, if the window width is less than
// the length of s, we returns the name directly.
if width < len([]rune(s)) {
return slice[i].name
}
return s
}))
}
Output:
func FindMulti ¶
FindMulti is nearly same as the Find. The only one difference point from Find is the user can select multiple items at once by tab key.
Example ¶
package main
import (
"fmt"
fuzzyfinder "github.com/umaumax/go-fuzzyfinder"
)
func main() {
slice := []struct {
id string
name string
}{
{"id1", "foo"},
{"id2", "bar"},
{"id3", "baz"},
}
idxs, _ := fuzzyfinder.FindMulti(slice, func(i int) string {
return fmt.Sprintf("[%s] %s", slice[i].id, slice[i].name)
})
for _, idx := range idxs {
fmt.Println(slice[idx])
}
}
Output:
Types ¶
type Option ¶
type Option func(*opt)
Option represents available fuzzy-finding options.
func WithMode ¶
func WithMode(m mode) Option
WithMode specifies a matching mode. The default mode is ModeSmart.
func WithPreviewWindow ¶
WithPreviewWindow enables to display a preview for the selected item. The argument f receives i, width and height. i is the same as Find's one. width and height are the size of the terminal so that you can use these to adjust a preview content. Note that width and height are calculated as a rune-based length.
If there is no selected item, previewFunc passes -1 to previewFunc.
If f is nil, the preview feature is disabled.
type TerminalMock ¶
type TerminalMock struct {
// contains filtered or unexported fields
}
TerminalMock is a mocked terminal for testing. Most users should use it by calling UseMockedTerminal.
Example ¶
package main
import (
"io/ioutil"
"github.com/gdamore/tcell/termbox"
fuzzyfinder "github.com/umaumax/go-fuzzyfinder"
)
func main() {
keys := func(str string) []termbox.Event {
s := []rune(str)
e := make([]termbox.Event, 0, len(s))
for _, r := range s {
e = append(e, termbox.Event{Type: termbox.EventKey, Ch: r})
}
return e
}
// Initialize a mocked terminal.
term := fuzzyfinder.UseMockedTerminal()
// Set the window size and events.
term.SetSize(60, 10)
term.SetEvents(append(
keys("foo"),
termbox.Event{Type: termbox.EventKey, Key: termbox.KeyEsc})...)
// Call fuzzyfinder.Find.
slice := []string{"foo", "bar", "baz"}
fuzzyfinder.Find(slice, func(i int) string { return slice[i] })
// Write out the execution result to a temp file.
// We can test it by the golden files testing pattern.
//
// See https://speakerdeck.com/mitchellh/advanced-testing-with-go?slide=19
res := term.GetResult()
ioutil.WriteFile("ui.out", []byte(res), 0644)
}
Output:
func UseMockedTerminal ¶
func UseMockedTerminal() *TerminalMock
UseMockedTerminal switches the terminal, which is used from this package to a mocked one.
func (*TerminalMock) GetResult ¶
func (m *TerminalMock) GetResult() string
GetResult returns a flushed string that is displayed to the actual terminal. It contains all escape sequences such that ANSI escape code.
func (*TerminalMock) SetEvents ¶
func (m *TerminalMock) SetEvents(e ...termbox.Event)
SetEvents sets all events, which are fetched by pollEvent. A user of this must set the EscKey event at the end.
func (*TerminalMock) SetSize ¶
func (m *TerminalMock) SetSize(w, h int)
SetSize changes the pseudo-size of the window. Note that SetSize resets added cells.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
_example
|
|
|
Package matching provides matching features that find appropriate strings by using a passed input string.
|
Package matching provides matching features that find appropriate strings by using a passed input string. |
|
Package scoring provides APIs that calculates similarity scores between two strings.
|
Package scoring provides APIs that calculates similarity scores between two strings. |