reporeader

Documentation

Index

• type FakeRepoReader
  • func (r FakeRepoReader) Exists(path string) bool
  • func (r FakeRepoReader) FindFiles(path string, patterns []string, maxDepth int) ([]string, error)
  • func (FakeRepoReader) GetRepoName() (string, error)
  • func (r FakeRepoReader) ReadFile(path string) ([]byte, error)
• type RepoReader
• type VariableExtractor

Types

type FakeRepoReader

type FakeRepoReader struct {
	Files map[string][]byte
}

FakeRepoReader is a RepoReader that can be used for testing, and takes a list of relative file paths with their contents

func (FakeRepoReader) Exists

func (r FakeRepoReader) Exists(path string) bool

func (FakeRepoReader) FindFiles

func (r FakeRepoReader) FindFiles(path string, patterns []string, maxDepth int) ([]string, error)

func (FakeRepoReader) GetRepoName

func (FakeRepoReader) GetRepoName() (string, error)

GetRepoName returns the name of the repo

func (FakeRepoReader) ReadFile

func (r FakeRepoReader) ReadFile(path string) ([]byte, error)

type RepoReader

type RepoReader interface {
	Exists(path string) bool
	ReadFile(path string) ([]byte, error)
	// FindFiles returns a list of files that match the given patterns searching up to
	// maxDepth nested sub-directories. maxDepth of 0 limits files to the root dir.
	FindFiles(path string, patterns []string, maxDepth int) ([]string, error)
	GetRepoName() (string, error)
}

type VariableExtractor

type VariableExtractor interface {
	ReadDefaults(r RepoReader) (map[string]string, error)
	MatchesLanguage(lowerlang string) bool
	GetName() string
}

VariableExtractor is an interface that can be implemented for extracting variables from a repo's files