internal

Documentation

Index

• func CleanID(id string) string
• func CleanLabel(label string) string
• func ConvertToMermaidFlowchart(graph *gographviz.Graph, direction string, subgraphName string) (string, error)
• func ExtractProvider(label string) string
• func ParseTerraform(workingDir, tfPath, planFile string) (*gographviz.Graph, error)
• type Edge
• type Graph
  • func TransformGraph(graph *gographviz.Graph) Graph
• type Node

Functions

func CleanID

func CleanID(id string) string

CleanID removes unnecessary parts from the ID

func CleanLabel

func CleanLabel(label string) string

CleanLabel removes unnecessary parts from the label

func ConvertToMermaidFlowchart

func ConvertToMermaidFlowchart(graph *gographviz.Graph, direction string, subgraphName string) (string, error)

ConvertToMermaidFlowchart converts a gographviz graph to a Mermaid.js compatible string. It accepts a graph, direction, and an optional subgraph name.

func ExtractProvider

func ExtractProvider(label string) string

ExtractProvider extracts the provider for separate subgraph

func ParseTerraform

func ParseTerraform(workingDir, tfPath, planFile string) (*gographviz.Graph, error)

ParseTerraform parses the Terraform plan and returns the generated graph

Types

type Edge

type Edge struct {
	From string
	To   string
}

type Graph

type Graph struct {
	Nodes   []Node
	Edges   []Edge
	NodeMap map[string]int
}

func TransformGraph

func TransformGraph(graph *gographviz.Graph) Graph

TransformGraph transforms the parsed graph into cleaned nodes and edges

type Node

type Node struct {
	ID       string
	Label    string
	Count    int
	Provider string
}