check

Documentation

Index

• type Break
  • func Init(workingPath string, startPoint string, endPoint string, configPath string) (*Break, error)
  • func (b *Break) Report() (*BreakReport, error)
• type BreakReport
• type FileReport
  • func (fr *FileReport) Report() string

Types

type Break

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

Break represents base structure required for evaluating code changes

func Init

func Init(workingPath string, startPoint string, endPoint string, configPath string) (*Break, error)

Init bootstraps Break structure

func (*Break) Report

func (b *Break) Report() (*BreakReport, error)

Report displays a BreakReport

type BreakReport

type BreakReport struct {
	Supported  []FileReport
	Ignored    []file
	Exclusions []string
}

BreakReport is a report to display

type FileReport

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

FileReport is a pool of potentials compatibility breaks

func (*FileReport) Report

func (fr *FileReport) Report() string

Report displays a FileReport and its potentials compatibility breaks