README.md

find

Simple find module for go applications

Install:

go get github.com/emar-kar/find@latest

Usage:

Find allows to search files and folders with the given template:

ctx, cancel := context.WithDeadline(
  context.Background(),
  time.Now().Add(5*time.Minute),
)
defer cancel()

where := "path/to/the/source"

// Since recursive search does not active by default,
// Find will search for files and folders only in the
// root of where.
results, err := Find(ctx, where, "*template*")
if err != nil {
  log.Println(err)

  return
}

for _, r := range results {
  fmt.Println(r)
}

Setup:

Find supports several options for search customization:

• SearchFor is deprecated, use Only instead;
• Only - defines the type of the searched object: files, folders or both;

   // Type of the searched object.
   const (
   	File uint8 = iota
   	Folder
   	Both
   )

• SearchRecursively is deprecated, use Recursively instead;
• Recursively - activates recursive search, disabled by default;
• SearchName is deprecated, use Name instead;
• Name - result will containt only names of the searched objects, not paths;
• SearchStrict is deprecated, use Strict instead;
• Strict - since Find supports passing several templates during search, by default path will be returned if it matchs any of the given templates. This option switch this behavior to match all of the templates;
• MatchTree - matches the whole path instead of the object name;
• RelativePaths - does not resolve paths in output;
• WithErrorsSkip - skips errors during execution, returns nil in result, only if the root where was resolved;
• WithErrosLog - logs errors during execution;
• WithOutput - prints found paths during the process, before return.

// defaultOptions default Find options.
func defaultOptions() *options {
	return &options{
		matchFunc: MatchAny,
		fType:     Both,
		rec:       false,
		name:      false,
	}
}

Find uses generic templates, which can be a simple string type or a slice of strings []string{}.

String can contain the following setup:

• str&str1 - means that searched path should be both str and str1
• str|str1 - means that searched path should be str or str1
• *str - means that searched path should ends with str
• str* - means that searched path should starts with str
• *str* - means that searched path should contain str
• str - means that searched path should be str
• !str - means that searched path should not be str
• !*str - means that searched path should not end with str
• !str* - means that searched path should not start with str
• !*str* - means that searched path should not contain str