gocyclo

package module

v0.2.0 Latest Latest Go to latest Published: Oct 17, 2020 License: BSD-3-Clause Imports: 10 Imported by: 18

Details

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', 'default', '&&' or '||'

To install, run

$ go get github.com/fzipp/gocyclo/cmd/gocyclo

and put the resulting binary in one of your PATH directories if $GOPATH/bin isn't already in your PATH.

Usage:

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

Examples:

$ gocyclo .
$ gocyclo main.go
$ gocyclo -top 10 src/
$ gocyclo -over 25 docker
$ gocyclo -avg .
$ gocyclo -ignore "_test|Godeps" .

The output fields for each line are:

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

Individual functions can be ignored with a gocyclo:ignore directive:

//gocyclo:ignore
func f() {
    // ...
}

//gocyclo:ignore
var g = func() {
}

This section is empty.

This section is empty.

func Complexity(fn ast.Node) int

Complexity calculates the cyclomatic complexity of a function.

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

func (s Stat) String() string

type Stats []Stat

func Analyze(paths []string, ignore *regexp.Regexp) Stats

func (s Stats) AverageComplexity() float64

func (s Stats) SortAndFilter(top, over int) Stats

func (s Stats) TotalComplexity() uint64

Path	Synopsis
cmd
gocyclo command Gocyclo calculates the cyclomatic complexities of functions and methods in Go source code.	Gocyclo calculates the cyclomatic complexities of functions and methods in Go source code.