search

package

v3.2.3 Latest Latest Go to latest Published: Sep 18, 2023 License: MIT Imports: 5 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func NewFlags() []cli.Flag

NewFlags generates command line flags to configure the search.

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

NewOptions search options from command line arguments

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 (e ErrNotFound) Error() string

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 func(path string, info os.FileInfo) (bool, error)

MatchFunc is the interface of match functions.

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

Search implements a search.

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

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

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

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