discovery

Documentation

Index

• Constants
• type ChangeType
  • func (c *ChangeType) MarshalJSON() ([]byte, error)
  • func (c ChangeType) String() string
• type Entry
• type FileIgnoreError
  • func (fe FileIgnoreError) Error() string
• type GitBranchFinder
  • func NewGitBranchFinder(gitCmd git.CommandRunner, filter git.PathFilter, baseBranch string, ...) GitBranchFinder
  • func (f GitBranchFinder) Find(allEntries []Entry) (entries []Entry, err error)
• type GlobFinder
  • func NewGlobFinder(patterns []string, filter git.PathFilter) GlobFinder
  • func (f GlobFinder) Find() (entries []Entry, err error)
• type Path
  • func (p Path) String() string

Constants

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

Types

type ChangeType

type ChangeType uint8

const (
	Unknown ChangeType = iota
	Noop
	Added
	Modified
	Removed
	Moved
	Excluded
)

func (*ChangeType) MarshalJSON

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

func (ChangeType) String

func (c ChangeType) String() string

type Entry

type Entry struct {
	PathError      error
	Path           Path
	Owner          string
	ModifiedLines  []int
	DisabledChecks []string
	Rule           parser.Rule
	State          ChangeType
}

type FileIgnoreError

type FileIgnoreError struct {
	Err  error
	Line int
}

func (FileIgnoreError) Error

func (fe FileIgnoreError) Error() string

type GitBranchFinder

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

func NewGitBranchFinder

func NewGitBranchFinder(
	gitCmd git.CommandRunner,
	filter git.PathFilter,
	baseBranch string,
	maxCommits int,
) GitBranchFinder

func (GitBranchFinder) Find

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

type GlobFinder

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

func NewGlobFinder

func NewGlobFinder(patterns []string, filter git.PathFilter) GlobFinder

func (GlobFinder) Find

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

type Path

type Path struct {
	Name          string // file path, it can be symlink
	SymlinkTarget string // symlink target, or the same as name if not a symlink
}

func (Path) String

func (p Path) String() string