discovery

Documentation

Index

• Constants
• Variables
• type ChangeType
  • func (c *ChangeType) MarshalJSON() ([]byte, error)
  • func (c ChangeType) String() string
• type Entry
• type GitBlameFinder
  • func NewGitBlameFinder(gitCmd git.CommandRunner, include []*regexp.Regexp, exclude []*regexp.Regexp, ...) GitBlameFinder
  • func (f GitBlameFinder) Find() (entries []Entry, err error)
• type GitBranchFinder
  • func NewGitBranchFinder(gitCmd git.CommandRunner, include []*regexp.Regexp, exclude []*regexp.Regexp, ...) 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"
	FileSnoozeCheckComment   = "file/snooze"
	RuleOwnerComment         = "rule/owner"
)

Variables

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

Types

type ChangeType

type ChangeType int

const (
	Unknown ChangeType = iota
	Noop
	Added
	Modified
	Removed
)

func (*ChangeType) MarshalJSON

func (c *ChangeType) MarshalJSON() ([]byte, error)

func (ChangeType) String

func (c ChangeType) String() string

type Entry

type Entry struct {
	State          ChangeType
	ReportedPath   string // symlink target
	SourcePath     string // file path (can be symlink)
	PathError      error
	ModifiedLines  []int
	Rule           parser.Rule
	Owner          string
	DisabledChecks []string
}

type GitBlameFinder

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

func NewGitBlameFinder

func NewGitBlameFinder(
	gitCmd git.CommandRunner,
	include []*regexp.Regexp,
	exclude []*regexp.Regexp,
	baseBranch string,
	maxCommits int,
	relaxed []*regexp.Regexp,
) GitBlameFinder

func (GitBlameFinder) Find

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

type GitBranchFinder

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

func NewGitBranchFinder

func NewGitBranchFinder(
	gitCmd git.CommandRunner,
	include []*regexp.Regexp,
	exclude []*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)
}