churn

Documentation

Overview

Package churn cross-references git log with per-function complexity scores using a language-supplied lang.ComplexityScorer. The AST-level work lives in the language back-end (for Go: goanalyzer/complexity.go); this file owns the git log counting (which is language-agnostic) and the severity derivation.

Index

• func Analyze(repoPath string, d *diff.Result, complexityThreshold int, ...) (report.Section, error)
• type FunctionChurn

Functions

func Analyze

func Analyze(repoPath string, d *diff.Result, complexityThreshold int, scorer lang.ComplexityScorer) (report.Section, error)

Analyze cross-references git log with per-function complexity scores for the diff's changed files.

Types

type FunctionChurn

type FunctionChurn struct {
	File       string
	Line       int
	Name       string
	Commits    int
	Complexity int
	Score      float64
}

FunctionChurn holds churn and complexity data for a single function.