architecture

Documentation

Overview

Package architecture provides checks targeting architecture conventions

Index

• type Analyzer
  • func (d *Analyzer) ChecksToExecute() []*analysis.Analyzer
  • func (d *Analyzer) Inject(config configuration.AnalyzerConfig)
• type Module
  • func (m *Module) Configure(injector *dingo.Injector)
• type Props

Types

type Analyzer

type Analyzer struct {
	// contains filtered or unexported fields
}

The Analyzer holds a set of checks, uses the config and has props that can be defined to get read by the config

func (*Analyzer) ChecksToExecute

func (d *Analyzer) ChecksToExecute() []*analysis.Analyzer

ChecksToExecute decides which checks to run

func (*Analyzer) Inject

func (d *Analyzer) Inject(config configuration.AnalyzerConfig)

Inject dependencies

type Module

type Module struct{}

Module to register the architecture checks

func (*Module) Configure

func (m *Module) Configure(injector *dingo.Injector)

Configure DI

type Props

type Props struct {
	Name                       string
	EntryPaths                 []string
	CheckDependencyConventions bool
	Groups                     map[string][]string
}

Props of an analyzer which will be used by the config-module to match the entries of a file to this variables. Is used to activate and deactivate checks, for example.