discovery

Documentation

Index

• Constants
• Variables
• type Entry
• type GitBranchFinder
  • func NewGitBranchFinder(gitCmd git.CommandRunner, include []*regexp.Regexp, baseBranch string, ...) GitBranchFinder
  • func (f GitBranchFinder) Find() (entries []Entry, err error)
• type GlobFinder
  • func NewGlobFinder(patterns []string, relaxed []*regexp.Regexp) GlobFinder
  • func (f GlobFinder) Find() (entries []Entry, err error)
• type RuleFinder

Constants

const (
	FileOwnerComment         = "file/owner"
	FileDisabledCheckComment = "file/disable"
	RuleOwnerComment         = "rule/owner"
)

Variables

var ErrFileIsIgnored = errors.New("file was ignored")

Types

type Entry

type Entry struct {
	ReportedPath   string
	SourcePath     string
	PathError      error
	ModifiedLines  []int
	Rule           parser.Rule
	Owner          string
	DisabledChecks []string
}

type GitBranchFinder

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

func NewGitBranchFinder

func NewGitBranchFinder(
	gitCmd git.CommandRunner,
	include []*regexp.Regexp,
	baseBranch string,
	maxCommits int,
	relaxed []*regexp.Regexp,
) GitBranchFinder

func (GitBranchFinder) Find

func (f GitBranchFinder) Find() (entries []Entry, err error)

type GlobFinder

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

func NewGlobFinder

func NewGlobFinder(patterns []string, relaxed []*regexp.Regexp) GlobFinder

func (GlobFinder) Find

func (f GlobFinder) Find() (entries []Entry, err error)

type RuleFinder

type RuleFinder interface {
	Find() ([]Entry, error)
}