internal

Documentation

Index

• Constants
• Variables
• func CacheDir(appName string) (string, error)
• func CheckDestination(dest string) (bool, error)
• func ConfigDir(appName string) (string, error)
• func DataDir(appName string) (string, error)
• func Find(path string) (string, bool, error)
• func Pick(query string, candidates []Candidate, options ...picker.Option) (int, bool, error)
• func Run(args []string, stdout io.Writer, stderr io.Writer, deps CliDependencies) error
• func WriteFile(path string, data []byte, perm os.FileMode) error
• func ZshInitSnippet() string
• type App
  • func NewApp(sources []Source, sourceOptions ...Option) (*App, error)
  • func (a *App) Prune() error
  • func (a *App) Query(ctx context.Context, query string, stdout io.Writer) error
  • func (a *App) Refresh(ctx context.Context) error
  • func (a *App) Track(repoPath string) error
• type Candidate
• type CliDependencies
• type Cloner
• type ClonerFunc
  • func (f ClonerFunc) Clone(repo Repo) (string, error)
• type Entry
• type Option
  • func WithPicker(picker Picker) Option
• type Picker
• type PickerFunc
  • func (f PickerFunc) Pick(query string, candidates []Candidate) (int, bool, error)
• type Prunable
• type Pruner
• type PrunerFunc
  • func (f PrunerFunc) Launch()
• type Refreshable
• type Refresher
• type RefresherFunc
  • func (f RefresherFunc) Launch()
• type Repo
• type Runner
• type RunnerFunc
  • func (f RunnerFunc) Run(ctx context.Context, name string, args ...string) ([]byte, error)
• type Source
• type Trackable

Constants

const (
	CandidateMetaLabel    = "label"
	CandidateMetaKind     = "kind"
	CandidateMetaPath     = "path"
	CandidateMetaName     = "name"
	CandidateMetaFullName = "full_name"
	CandidateMetaSSHURL   = "ssh_url"
	CandidateMetaSource   = "source"

	CandidateSourceLocal  = "local"
	CandidateSourceRemote = "remote"
	CandidateSourceZoxide = "zoxide"

	CandidateSignalZoxideScore = "source.zoxide.score"
)

const (
	CloneToCWDFlag     = "-c"
	CloneToCWDLongFlag = "--cwd"
	Usage              = "usage: fly [query] | fly -c [query] | fly init | fly refresh | fly track"
)

Variables

var ErrNoReposTracked = errors.New("no repos tracked yet")

var ErrUnsupportedCandidate = errors.New("unsupported candidate")

Functions

func CacheDir

func CacheDir(appName string) (string, error)

func CheckDestination

func CheckDestination(dest string) (bool, error)

func ConfigDir

func ConfigDir(appName string) (string, error)

func DataDir

func DataDir(appName string) (string, error)

func Find

func Find(path string) (string, bool, error)

func Pick

func Pick(query string, candidates []Candidate, options ...picker.Option) (int, bool, error)

func Run

func Run(args []string, stdout io.Writer, stderr io.Writer, deps CliDependencies) error

func WriteFile

func WriteFile(path string, data []byte, perm os.FileMode) error

func ZshInitSnippet

func ZshInitSnippet() string

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func NewApp

func NewApp(sources []Source, sourceOptions ...Option) (*App, error)

func (*App) Prune

func (a *App) Prune() error

func (*App) Query

func (a *App) Query(ctx context.Context, query string, stdout io.Writer) error

func (*App) Refresh

func (a *App) Refresh(ctx context.Context) error

func (*App) Track

func (a *App) Track(repoPath string) error

type Candidate

type Candidate struct {
	Signals map[string]float64
	Meta    map[string]string
	// contains filtered or unexported fields
}

type CliDependencies

type CliDependencies struct {
	Init    func(io.Writer) error
	Refresh func() error
	Prune   func() error
	Track   func() error
	Query   func(string, io.Writer) error
}

type Cloner

type Cloner interface {
	Clone(Repo) (string, error)
}

type ClonerFunc

type ClonerFunc func(Repo) (string, error)

func (ClonerFunc) Clone

func (f ClonerFunc) Clone(repo Repo) (string, error)

type Entry

type Entry struct {
	Name string `json:"name"`
	Path string `json:"path"`
}

type Option

type Option func(*options) error

func WithPicker

func WithPicker(picker Picker) Option

type Picker

type Picker interface {
	Pick(string, []Candidate) (int, bool, error)
}

type PickerFunc

type PickerFunc func(string, []Candidate) (int, bool, error)

func (PickerFunc) Pick

func (f PickerFunc) Pick(query string, candidates []Candidate) (int, bool, error)

type Prunable

type Prunable interface {
	Prune() error
}

type Pruner

type Pruner interface {
	Launch()
}

type PrunerFunc

type PrunerFunc func()

func (PrunerFunc) Launch

func (f PrunerFunc) Launch()

type Refreshable

type Refreshable interface {
	Refresh(context.Context) error
}

type Refresher

type Refresher interface {
	Launch()
}

type RefresherFunc

type RefresherFunc func()

func (RefresherFunc) Launch

func (f RefresherFunc) Launch()

type Repo

type Repo struct {
	Name     string `json:"name"`
	FullName string `json:"full_name"`
	SSHURL   string `json:"ssh_url"`
}

type Runner

type Runner interface {
	Run(ctx context.Context, name string, args ...string) ([]byte, error)
}

type RunnerFunc

type RunnerFunc func(context.Context, string, ...string) ([]byte, error)

func (RunnerFunc) Run

func (f RunnerFunc) Run(ctx context.Context, name string, args ...string) ([]byte, error)

type Source

type Source interface {
	Load(context.Context, string) ([]Candidate, error)
	Resolve(Candidate) (string, error)
}

type Trackable

type Trackable interface {
	Track(string) error
}