switchchecker

README

switchchecker

This Repository is inspired from https://github.com/knightso/allcases

Install

$ go get github.com/esh2n/switchchecker/cmd/switchchecker

How to use

Usage

$ allcases [-flag] [package]

• flags are only ones took over from https://godoc.org/golang.org/x/tools/go/analysis tool. check allcases -help for them.
• package format is based on go tools such as ./... .

Annotation

This checker checks for switch statements which have an annotation comment // switchchecker to have all cases for consts of the expression type.

For example if there is a type and consts like:

	type TestKind int

	const (
		TestKindHoge TestKind = iota
		TestKindFuga
		TestKindPiyo
	)

and switch statements like:

	// allcases
	switch v {
	case TestKindHoge:
		// do something
	case TestKindFuga:
		// do something
	}

and also exclude case like:

	// allcases -exclude TestKindFuga
	switch v {
	case TestKindHoge:
		// do something
	}

then the checker reports that the switch statement doesn't have the TestKindPiyo case.

Documentation

Index

• Constants
• Variables

Constants

const Doc = `` /* 565-byte string literal not displayed */

Variables

var Analyzer = &analysis.Analyzer{
	Name:             "switchchecker",
	Doc:              Doc,
	Run:              run,
	RunDespiteErrors: true,
	Requires: []*analysis.Analyzer{
		inspect.Analyzer,
		commentmap.Analyzer,
	},
	FactTypes: []analysis.Fact{new(fact)},
}