maintidx

README

maintidx

maintidx measures the maintainability index of each function.
https://docs.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning

Installation

Go version < 1.16

go get -u github.com/yagipy/maintidx/cmd/maintidx

Go version 1.16+

go install github.com/yagipy/maintidx/cmd/maintidx

Usage

standalone

maintidx ./...

with go run

No installation required

go run github.com/yagipy/maintidx/cmd/maintidx ./...

with go vet

go vet -vettool=`which maintidx` ./...

Flag

Flags:
  -under int
    	show functions with maintainability index < N only. (default 20)

TODO

• Setup execute env on container
• Impl cyc.Cyc.Calc()
• Move maintidx.Visitor.PrintHalstVol to halstval package
• Consider the necessity of halstvol.incrIfAllTrue
• Test under pkg file

Documentation

Index

• Variables
• type Coef
• type Visitor
  • func NewVisitor() *Visitor
  • func (v *Visitor) Visit(n ast.Node) ast.Visitor

Variables

var Analyzer = &analysis.Analyzer{
	Name: "maintidx",
	Doc:  doc,
	Run:  run,
	Requires: []*analysis.Analyzer{
		inspect.Analyzer,
	},
}

Types

type Coef

type Coef struct {
	Cyc      cyc.Cyc
	HalstVol halstvol.HalstVol
}

type Visitor

type Visitor struct {
	MaintIdx int
	Coef     Coef
}

func NewVisitor

func NewVisitor() *Visitor

func (*Visitor) Visit

func (v *Visitor) Visit(n ast.Node) ast.Visitor