globalvar

README

yze-go-globalvar

A yze analyzer (category immutability) that reports package-level mutable vars, which the gomatic immutability/dependency-injection standard forbids: prefer a constant or dependency injection. A small allow-listed set of sanctioned package vars (version, Analyzer, Registration) — plus any configured via the -allow flag — is permitted.

• Rule: yze/globalvar
• Library: exports Analyzer (a standard go/analysis analyzer) and Registration for the yze aggregator and stickler runner.
• Binary: cmd/yze-go-globalvar runs it standalone (text/-json, and as a go vet -vettool).
• Config: -allow takes a comma-separated list of additional permitted package-level var names.

Built on the go-yze framework.

Documentation

Overview

Package globalvar provides a go/analysis analyzer enforcing the gomatic immutability/DI standard: package-level mutable vars are forbidden. Prefer a constant or dependency injection. A small allow-listed set of sanctioned package vars (and any configured via the -allow flag) is permitted.

Index

• Variables

Variables

var Analyzer = newAnalyzer()

Analyzer reports package-level mutable vars that are not allow-listed.

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

Registration declares this analyzer to the yze framework.