gocyclo

README

Gocyclo calculates cyclomatic complexities of functions in Go source code.

The cyclomatic complexity of a function is calculated according to the following rules:

 1 is the base complexity of a function
+1 for each 'if', 'for', 'case', '&&' or '||'

To install, run

$ go get -u github.com/gregoryv/gocyclo/...

Usage:

$ gocyclo [<flag> ...] <Go file or directory> ...

Examples:

$ gocyclo .
$ gocyclo main.go
$ gocyclo -top 10 src/
$ gocyclo -over 5 *.go
$ gocyclo -avg .

The output fields for each line are:

<complexity> <package> <function> <file:row:column>

As unit test

func TestComplexity(t *testing.T) {
	files, err := filepath.Glob("*.go")
	if err != nil {
		t.Fatal(err)
	}
	max := 5
	result, ok := gocyclo.Assert(files, max)
	if !ok {
		for _, l := range result {
			t.Log(l)
		}
		t.Errorf("Exceeded maximum complexity %v", max)
	}
}

Documentation

Index

• func Average(stats []Stat) float64
• type Stat
  • func Analyze(paths []string) []Stat
  • func Assert(paths []string, over int) (result []Stat, ok bool)
  • func Filter(sortedStats []Stat, top, over int) (filtered []Stat)
  • func (s Stat) String() string

Functions

func Average

func Average(stats []Stat) float64

Types

type Stat

type Stat struct {
	PkgName    string
	FuncName   string
	Complexity int
	Pos        token.Position
}

func Analyze

func Analyze(paths []string) []Stat

func Assert

func Assert(paths []string, over int) (result []Stat, ok bool)

func Filter

func Filter(sortedStats []Stat, top, over int) (filtered []Stat)

func (Stat) String

func (s Stat) String() string