services

Documentation

Index

• Constants
• type CollectorProvider
  • func NewCollectorProvider() *CollectorProvider
  • func (p *CollectorProvider) Get(id enums.CollectorType) services.CollectorInterface
  • func (p *CollectorProvider) GetKnownCollectors() []enums.CollectorType
  • func (p *CollectorProvider) Has(id enums.CollectorType) bool
  • func (p *CollectorProvider) Set(collectors map[enums.CollectorType]services.CollectorInterface) *CollectorProvider
• type DependencyResolver
  • func NewDependencyResolver(typesConfig *configs.AnalyserConfig, ...) *DependencyResolver
  • func (r *DependencyResolver) Resolve(astMap *ast_maps.AstMap) (*dependencies.DependencyList, error)
• type EventHelper
  • func NewEventHelper(skippedViolations map[string][]string, layerProvider *LayerProvider) *EventHelper
  • func (e *EventHelper) AddSkippableViolation(event *events.ProcessEvent, analysisResult *results.AnalysisResult, ...)
  • func (e *EventHelper) UnmatchedSkippedViolations() map[string][]string
• type InheritanceFlattener
  • func NewInheritanceFlattener() *InheritanceFlattener
  • func (f *InheritanceFlattener) FlattenDependencies(astMap ast_maps.AstMap, dependencyList *dependencies.DependencyList)
• type LayerProvider
  • func NewLayerProvider(allowedLayers map[string]*rules.Ruleset) *LayerProvider
  • func (l *LayerProvider) GetAllowedLayers(layerName string) ([]string, error)
• type OutputInterface
• type OutputStyleInterface
• type StringOrArrayOfStrings
  • func (s StringOrArrayOfStrings) ToString() string
• type StringOrArrayOfStringsOrTableSeparator
• type TokenResolver
  • func NewTokenResolver() *TokenResolver
  • func (r *TokenResolver) Resolve(token tokens.TokenInterface, astMap *ast_maps.AstMap) tokens_references.TokenReferenceInterface

Constants

const ProgressAdvanceDefault = 1

Types

type CollectorProvider

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

func NewCollectorProvider

func NewCollectorProvider() *CollectorProvider

func (*CollectorProvider) Get

func (p *CollectorProvider) Get(id enums.CollectorType) services.CollectorInterface

func (*CollectorProvider) GetKnownCollectors

func (p *CollectorProvider) GetKnownCollectors() []enums.CollectorType

func (*CollectorProvider) Has

func (p *CollectorProvider) Has(id enums.CollectorType) bool

func (*CollectorProvider) Set

func (p *CollectorProvider) Set(collectors map[enums.CollectorType]services.CollectorInterface) *CollectorProvider

type DependencyResolver

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

func NewDependencyResolver

func NewDependencyResolver(typesConfig *configs.AnalyserConfig, emitterLocator map[enums.EmitterType]emitters.DependencyEmitterInterface, inheritanceFlattener *InheritanceFlattener, eventDispatcher event_dispatchers.EventDispatcherInterface) *DependencyResolver

func (*DependencyResolver) Resolve

func (r *DependencyResolver) Resolve(astMap *ast_maps.AstMap) (*dependencies.DependencyList, error)

type EventHelper

type EventHelper struct {
	UnmatchedSkippedViolation map[string][]string
	SkippedViolations         map[string][]string
	LayerProvider             *LayerProvider
}

EventHelper - Utility class for managing adding violations that could be skipped.

func NewEventHelper

func NewEventHelper(skippedViolations map[string][]string, layerProvider *LayerProvider) *EventHelper

func (*EventHelper) AddSkippableViolation

func (e *EventHelper) AddSkippableViolation(event *events.ProcessEvent, analysisResult *results.AnalysisResult, dependentLayer string, violationCreatingRule violations_rules.ViolationCreatingInterface)

func (*EventHelper) UnmatchedSkippedViolations

func (e *EventHelper) UnmatchedSkippedViolations() map[string][]string

type InheritanceFlattener

type InheritanceFlattener struct{}

func NewInheritanceFlattener

func NewInheritanceFlattener() *InheritanceFlattener

func (*InheritanceFlattener) FlattenDependencies

func (f *InheritanceFlattener) FlattenDependencies(astMap ast_maps.AstMap, dependencyList *dependencies.DependencyList)

type LayerProvider

type LayerProvider struct {
	AllowedLayers map[string]*rules.Ruleset
}

func NewLayerProvider

func NewLayerProvider(allowedLayers map[string]*rules.Ruleset) *LayerProvider

func (*LayerProvider) GetAllowedLayers

func (l *LayerProvider) GetAllowedLayers(layerName string) ([]string, error)

type OutputInterface

type OutputInterface interface {
	WriteFormatted(message string)
	WriteLineFormatted(message StringOrArrayOfStrings)
	WriteRaw(message string)
	GetStyle() OutputStyleInterface
	IsVerbose() bool
	IsDebug() bool
}

OutputInterface - Wrapper around Symfony OutputInterface.

type OutputStyleInterface

type OutputStyleInterface interface {
	Title(message string)
	Section(message string)
	Success(message StringOrArrayOfStrings)
	Error(message StringOrArrayOfStrings)
	Warning(message StringOrArrayOfStrings)
	Note(message StringOrArrayOfStrings)
	Caution(message StringOrArrayOfStrings)
	DefinitionList(list []StringOrArrayOfStringsOrTableSeparator)
	Table(headers []string, rows [][]string)
	// NewLine - Writes a new line, default 1
	NewLine(count int)
	// ProgressStart - default 0
	ProgressStart(max int)
	// ProgressAdvance - default 1
	ProgressAdvance(step int) error
	ProgressFinish() error
	IsVerbose() bool
	IsDebug() bool
}

OutputStyleInterface - Wrapper around Symfony OutputStyleInterface.

type StringOrArrayOfStrings

type StringOrArrayOfStrings struct {
	Strings []string
	String  string
}

func (StringOrArrayOfStrings) ToString

func (s StringOrArrayOfStrings) ToString() string

type StringOrArrayOfStringsOrTableSeparator

type StringOrArrayOfStringsOrTableSeparator struct {
	StringsMap     map[string]string
	String         string
	TableSeparator bool
}

type TokenResolver

type TokenResolver struct{}

func NewTokenResolver

func NewTokenResolver() *TokenResolver

func (*TokenResolver) Resolve

func (r *TokenResolver) Resolve(token tokens.TokenInterface, astMap *ast_maps.AstMap) tokens_references.TokenReferenceInterface