Visualize a hierarchy of embedded Go structs
This tool scans a directory of Go source code files to create a visualization of struct embedding in the project. This can be useful for navigating the data structures of complex projects, or identifying dependencies on particular structures.
Example
This figure would be generated from the input file below:
package main
import (
"time"
"domain.tld/user"
)
type A struct {
B
C map[string]D
}
type B struct {
E, F string
G user.Status
Timer H
}
type D struct {
I uint64
}
type H struct {
Timer time.Ticker
J chan D
}
Usage
Install:
$ go install github.com/davidschlachter/embedded-struct-visualizer@latest
Or,
$ git clone https://github.com/davidschlachter/embedded-struct-visualizer
$ cd embedded-struct-visualizer
$ go install github.com/davidschlachter/embedded-struct-visualizer
Options:
$ embedded-struct-visualizer -h
Usage: embedded-struct-visualizer [OPTIONS] DirToScan
If the directory to scan is not provided, it defaults to './'
OPTIONS:
-out
path to output file (default: write to stdout)
-v verbose logging
To open a generated DOT file, you could use Graphviz or xdot.
