finder

Documentation

Index

• type FileFinder
• type FileMetadata
• type FileSystemFinder
  • func (fsf FileSystemFinder) Find(pathRoot string, fileTypes []filetype.FileType, excludeDirs []string) ([]FileMetadata, error)

Types

type FileFinder

type FileFinder interface {
	Find(pathRoot string, fileTypes []filetype.FileType, excludeDirs []string) ([]FileMetadata, error)
}

Find will return an array of FileMetadata objects from a provided path and array of FileTypes. Any files in subdirectories defined in excludeDirs will not be returned

type FileMetadata

type FileMetadata struct {
	Name     string
	Path     string
	FileType filetype.FileType
}

The File Metadata object stores the name and the path of the file and the type of file that it is, example: json, yml, etc

type FileSystemFinder

type FileSystemFinder struct{}

func (FileSystemFinder) Find

func (fsf FileSystemFinder) Find(pathRoot string, fileTypes []filetype.FileType, excludeDirs []string) ([]FileMetadata, error)

Find implements the FileFinder interface by recursively walking through all subdirectories (excluding the excluded subdirectories) and identifying if the file matches a type defined in the fileTypes array.