complexity

Documentation

Index

• Variables
• func PrintTabular(results FilesStat, out io.Writer)
• func ReadLizardXML(r io.Reader) (*lizardXML, error)
• type ChurnChunk
  • func ReadChurn(r io.Reader) ([]*ChurnChunk, error)
• type ComplexityOptions
• type Engine
• type FileStat
• type FilesStat
  • func ParseLizard(lizard *lizardXML) (FilesStat, error)
  • func RunLizardCmd(repoPath string, opts ComplexityOptions) (FilesStat, error)
• type FunctionStat
• type FunctionsStat

Variables

var ComplexityOpts = ComplexityOptions{
	Extensions: "",
	Threads:    1,
}

Functions

func PrintTabular

func PrintTabular(results FilesStat, out io.Writer)

func ReadLizardXML

func ReadLizardXML(r io.Reader) (*lizardXML, error)

Types

type ChurnChunk

type ChurnChunk struct {
	File    string `json:"path"`
	Churn   uint   `json:"changes"`
	Added   uint   `json:"additions"`
	Removed uint   `json:"deletions"`
	Commits uint   `json:"commits"`
}

func ReadChurn

func ReadChurn(r io.Reader) ([]*ChurnChunk, error)

type ComplexityOptions

type ComplexityOptions struct {
	Extensions string
	Threads    int
}

type Engine

type Engine = string

var (
	Lizard Engine = "lizard"
)

type FileStat

type FileStat struct {
	Path      string
	Functions FunctionsStat
}

type FilesStat

type FilesStat = []*FileStat

func ParseLizard

func ParseLizard(lizard *lizardXML) (FilesStat, error)

func RunLizardCmd

func RunLizardCmd(repoPath string, opts ComplexityOptions) (FilesStat, error)

type FunctionStat

type FunctionStat struct {
	File      string
	Package   []string
	Name      string
	Line      uint
	Length    uint
	Compexity uint
}

type FunctionsStat

type FunctionsStat = []FunctionStat