filereader

Documentation

Index

• Variables
• type FileReader
  • func New() FileReader
  • func (f FileReader) GitFile(absolutePath string) (pulse.GitFile, error)
• type Reader

Variables

var (
	ErrEmptyPath         = errors.New("path is empty string")
	ErrPathNotAFile      = errors.New("the path is not a file")
	ErrReachedRoot       = errors.New("we reached the root without finding a .git file or folder")
	ErrParseRepoPath     = errors.New("failed to parse repository path")
	ErrParseBareRepoPath = errors.New("failed to parse bare repository path")
)

Types

type FileReader

type FileReader struct {
	Reader Reader
}

func New

func New() FileReader

New creates a new FileReader.

func (FileReader) GitFile

func (f FileReader) GitFile(absolutePath string) (pulse.GitFile, error)

GitFile returns a GitFile struct from an absolute path. It will return an error if the path is empty, if the path is not a file or if it can't find a parent .git file or folder before it reaches the root of the file tree.

type Reader

type Reader interface {
	Dir(string) string
	ReadDir(string) ([]fs.DirEntry, error)
	ReadFile(string) ([]byte, error)
	IsFile(string) bool
}

Reader is an interface for the underlying reader. It is an abstraction to allow for easier testing.