Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.56 KB

README.md

File metadata and controls

51 lines (35 loc) · 1.56 KB
Raw

gochecknoglobals

test Go Report Card

Check that no globals are present in Go code.

Why

Global variables are an input to functions that is not visible in the functions signature, complicate testing, reduces readability and increase the complexity of code.

https://peter.bourgon.org/blog/2017/06/09/theory-of-modern-go.html https://twitter.com/davecheney/status/871939730761547776

Exceptions

There are very few exceptions to the global variable rule. This tool will ignore the following patterns:

  • Variables with an err or Err prefix that implement the error interface
  • Variables named _
  • Variables named version
  • Variables assigned from regexp.MustCompile()
  • Variables with a //go:embed comment

Install

go install 4d63.com/gochecknoglobals@latest

Usage

The linter is built on Go's analysis package and does thus support all the built in flags and features from this type. The analyzer is executed by specifying packages.

gochecknoglobals [package]

gochecknoglobals ./...

By default, test files are checked but can be excluded by adding the -test=false flag.

gochecknoglobals -test=false [package]