dep_tree

Documentation

Index

• Constants
• func PrintStructured[T any](files []string, parser NodeParser[T]) (string, error)
• type DepTree
  • func NewDepTree[T any](parser NodeParser[T], ids []string) *DepTree[T]
  • func (dt *DepTree[T]) LoadCycles()
  • func (dt *DepTree[T]) LoadDeps() error
  • func (dt *DepTree[T]) LoadGraph() error
  • func (dt *DepTree[T]) LoadNodes() error
  • func (dt *DepTree[T]) Render() (*board.Board, error)
  • func (dt *DepTree[T]) RenderStructured() ([]byte, error)
  • func (dt *DepTree[T]) WithStdErrLoader() *DepTree[T]
• type DepTreeNode
• type NodeParser
• type NodeParserBuilder
• type StructuredTree
• type TestParser
  • func (t *TestParser) Deps(n *graph.Node[[]int]) ([]*graph.Node[[]int], error)
  • func (t *TestParser) Display(n *graph.Node[[]int]) string
  • func (t *TestParser) Node(id string) (*graph.Node[[]int], error)

Constants

const ConnectorDestinationNodeIdTag = "connectorDestination"

const ConnectorOriginNodeIdTag = "connectorOrigin"

const NodeFromTag = "nodeFrom"

const NodeIdTag = "nodeId"

const NodeIndexTag = "nodeIndex"

Functions

func PrintStructured

func PrintStructured[T any](
	files []string,
	parser NodeParser[T],
) (string, error)

Types

type DepTree

type DepTree[T any] struct {
	// Info present on DepTree construction.
	Ids []string
	NodeParser[T]
	// Info present just after node processing.
	Graph       *graph.Graph[T]
	Entrypoints []*graph.Node[T]
	Nodes       []*DepTreeNode[T]
	Cycles      *orderedmap.OrderedMap[[2]string, graph.Cycle]
	// contains filtered or unexported fields
}

func NewDepTree

func NewDepTree[T any](parser NodeParser[T], ids []string) *DepTree[T]

func (*DepTree[T]) LoadCycles

func (dt *DepTree[T]) LoadCycles()

func (*DepTree[T]) LoadDeps

func (dt *DepTree[T]) LoadDeps() error

func (*DepTree[T]) LoadGraph

func (dt *DepTree[T]) LoadGraph() error

func (*DepTree[T]) LoadNodes

func (dt *DepTree[T]) LoadNodes() error

func (*DepTree[T]) Render

func (dt *DepTree[T]) Render() (*board.Board, error)

func (*DepTree[T]) RenderStructured

func (dt *DepTree[T]) RenderStructured() ([]byte, error)

func (*DepTree[T]) WithStdErrLoader

func (dt *DepTree[T]) WithStdErrLoader() *DepTree[T]

type DepTreeNode

type DepTreeNode[T any] struct {
	Node *graph.Node[T]
	Lvl  int
}

type NodeParser

type NodeParser[T any] interface {
	Display(node *graph.Node[T]) string
	Node(id string) (*graph.Node[T], error)
	Deps(node *graph.Node[T]) ([]*graph.Node[T], error)
}

type NodeParserBuilder

type NodeParserBuilder[T any] func([]string) (NodeParser[T], error)

type StructuredTree

type StructuredTree struct {
	Tree                 map[string]interface{} `json:"tree" yaml:"tree"`
	CircularDependencies [][]string             `json:"circularDependencies" yaml:"circularDependencies"`
	Errors               map[string][]string    `json:"errors" yaml:"errors"`
}

type TestParser

type TestParser struct {
	Spec [][]int
}

func (*TestParser) Deps

func (t *TestParser) Deps(n *graph.Node[[]int]) ([]*graph.Node[[]int], error)

func (*TestParser) Display

func (t *TestParser) Display(n *graph.Node[[]int]) string

func (*TestParser) Node

func (t *TestParser) Node(id string) (*graph.Node[[]int], error)