model

Documentation

Overview

Package model contains structures and constructors used by anticycle analyze functions.

Index

• type Analysis
• type AnalysisMeta
• type Cycle
• type File
  • func NewFile() *File
• type ImportInfo
  • func NewImportInfo(imp *ast.ImportSpec) *ImportInfo
• type Pkg
  • func NewPkg() *Pkg

Types

type Analysis

type Analysis struct {
	Cycles   []*Pkg        `json:"cycles"`
	Metadata *AnalysisMeta `json:"metadata"`
}

Analysis holds final anticycle output.

type AnalysisMeta

type AnalysisMeta struct {
	Cycles [][]string `json:"cycles"`
}

AnalysisMeta is a metadata produced based on Analysis.

type Cycle

type Cycle struct {
	AffectedImport *ImportInfo `json:"affectedImport"`
	AffectedFile   string      `json:"affectedFile"`
}

Cycle holds information about affected file and import

type File

type File struct {
	Path    string        `json:"path"`
	Imports []*ImportInfo `json:"imports"`
}

File is a representation of source file with its path and list of imports.

func NewFile

func NewFile() *File

NewFile creates new File with empty imports array. Will return pointer to File structure.

type ImportInfo

type ImportInfo struct {
	Name      string  `json:"name"`
	NameShort string  `json:"nameShort"`
	Alias     *string `json:"alias"`
}

ImportInfo holds information about import statements.

func NewImportInfo

func NewImportInfo(imp *ast.ImportSpec) *ImportInfo

NewImportInfo creates new ImportInfo from ast.ImportSpec. Will produce full name, short name and alias if exist.

type Pkg

type Pkg struct {
	Name      string                 `json:"name"`
	Path      string                 `json:"path"`
	Imports   map[string]*ImportInfo `json:"imports"`
	Files     []*File                `json:"files"`
	Cycles    []*Cycle               `json:"cycles,omitempty"`
	HaveCycle bool                   `json:"haveCycle"`
}

Pkg is a higher level structure which has all information about its files and imports.

func NewPkg

func NewPkg() *Pkg

NewPkg creates new Pkg with empty imports, files and cycles arrays. Will return pointer to Pkg structure.