defaultcasechecker

README

defaultcasechecker

defaultcasechecker is a program for checking switch statement whether having default case.

Go does not provide exhaustive checks for switch statements. However, switch statements should always have a default case that either returns an appropriate error or performs some action. Therefore, this program identifies parts of switch statements that lack a default case.

Install

go install github/take-2405/defaultcasechecker@latest

Usage

Basic usage, specify the path of the package to check.

defaultcasechecker github.com/take-2405/defaultcasechecker

To check all packages

defaultcasechecker ./...

ignore test file

defaultcasechecker -check-test=true ./...

ignore generated file

defaultcasechecker -check-generate=true ./...

ignore specify switch statement

	//lint:ignore defaultcasechecker test ignore comment
	switch {
	case true:
		// do something
	case false:
		// do something
	}

Documentation

Index

• Constants
• Variables

Constants

const (
	CheckTest     = "check-test"
	CheckGenerate = "check-generate"
)

Variables

var Analyzer = &analysis.Analyzer{
	Name: "defaultcasechecker",
	Doc:  "checks for switch statements without default cases",
	Run:  run,
	Requires: []*analysis.Analyzer{
		commentmap.Analyzer,
	},
}