gocapsule

Documentation

Index

• Variables
• func New(settings any) (register.LinterPlugin, error)
• type EncapsulatedType
  • func (*EncapsulatedType) AFact()

Variables

var Analyzer = &analysis.Analyzer{
	Name:      "gocapsule",
	Doc:       "enforces encapsulation by preventing direct struct creation, type conversion, and field reassignment when New** constructors exist",
	Run:       run,
	Requires:  []*analysis.Analyzer{inspect.Analyzer},
	FactTypes: []analysis.Fact{new(EncapsulatedType)},
}

Analyzer is the gocapsule analyzer that enforces encapsulation.

Functions

func New

func New(settings any) (register.LinterPlugin, error)

New creates a new gocapsule plugin instance for golangci-lint.

Types

type EncapsulatedType

type EncapsulatedType struct {
	ConstructorName string
}

EncapsulatedType is a Fact indicating that a type (struct or defined type) has a corresponding New** constructor and should not be directly instantiated or have its fields reassigned from external packages.

func (*EncapsulatedType) AFact

func (*EncapsulatedType) AFact()

AFact implements the analysis.Fact interface.