boolname

README

docs

Documentation

Overview

Package boolname provides a go/analysis analyzer enforcing the gomatic Go boolean naming standard on struct fields and function parameters and results: bool and *bool names there carry an is/has/can/should/will predicate prefix, or an Enabled/Disabled flag suffix. Package-level and local variables, constants, and generic (~bool-constrained) type parameters are deliberately out of scope. For parameters and named results it offers a mechanical is-prefix rename fix.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "boolname",
	Doc:      "reports boolean struct fields, parameters, and results lacking an is/has/can/should/will prefix or an Enabled/Disabled suffix",
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
}

Analyzer reports boolean fields, parameters, and results that are not named as predicates or flags.

var Registration = goyze.Registration{
	Name:       "boolname",
	Categories: []goyze.Category{"naming"},
	URL:        "https://docs.gomatic.dev/yze/boolname",
	Analyzer:   Analyzer,
}

Registration declares this analyzer to the yze framework.