search

Documentation

Index

• func NewFlags() []cli.Flag
• func NewOptions(c *cli.Context) *walk.Options
• type ErrNotFound
  • func (e ErrNotFound) Error() string
  • func (e ErrNotFound) ExitCode() int
• type MatchFunc
• type Search
  • func New(mf MatchFunc, opts *walk.Options) *Search
  • func (s Search) Run(searchPath string) (string, error)

Functions

func NewFlags

func NewFlags() []cli.Flag

NewFlags generates command line flags to configure the search.

func NewOptions

func NewOptions(c *cli.Context) *walk.Options

NewOptions search options from command line arguments

Types

type ErrNotFound

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

ErrNotFound is emitted when the project dir tree search is finished but no matching files are found.

func (ErrNotFound) Error

func (e ErrNotFound) Error() string

func (ErrNotFound) ExitCode

func (e ErrNotFound) ExitCode() int

ExitCode returns the analyzer CLI application exit code which should be returned upon analyzer termination when ErrNotFound occurs.

type MatchFunc

type MatchFunc func(path string, info os.FileInfo) (bool, error)

MatchFunc is the interface of match functions.

type Search

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

Search implements a search.

func New

func New(mf MatchFunc, opts *walk.Options) *Search

New returns a new Search initialized with given matching function and options.

func (Search) Run

func (s Search) Run(searchPath string) (string, error)

Run performs a search on given path and returns matching path, otherwise an error.