GoPlantUML Documentation

GoPlantUML identifies two primary types of relationships in Go code:

1. Interface Implementation: When a struct implements all methods of an interface with matching signatures, an extends association (represented by <|-- in PlantUML) is created.
2. Type Composition: When a struct contains another type as a field, a composition or aggregation relationship is created (represented by *-- or o-- in PlantUML).

Example Logic:

• MyStruct1 implements MyInterface $\rightarrow$ MyInterface <|-- MyStruct1 (extends).
• MyStruct2 contains MyStruct1 as an embedded field $\rightarrow$ MyStruct1 *-- MyStruct2 (composition).
• MyStruct3 contains MyStruct1 as a named field $\rightarrow$ MyStruct3 o-- MyStruct1 (aggregation/association).

To use the goplantuml CLI tool, you need Go 1.17 or above. Install the parser library and the command-line tool using the following commands:

go get github.com/jfeliu007/goplantuml/parser
go install github.com/jfeliu007/goplantuml/cmd/goplantuml@latest

This will install the goplantuml binary in your $GOPATH/bin folder.

The goplantuml command generates PlantUML syntax from Go source files. You can output the result to standard output or to a specific file.

Basic Syntax:

goplantuml [-recursive] path/to/gofiles path/to/gofiles2 > diagram_file_name.puml

Example: To generate a class diagram from a specific directory and save it to ClassDiagram.puml:

goplantuml $GOPATH/src/github.com/jfeliu007/goplantuml/parser > ClassDiagram.puml

goplantuml is a command-line tool that parses Go source code and generates PlantUML class diagrams. You can specify one or more directories to scan, control the depth of package nesting, and customize which elements (fields, methods, connections, etc.) are rendered in the output.

Basic Usage

To generate a diagram for a directory and print it to standard output:

goplantuml ./path/to/your/go/code

To save the output to a specific file:

goplantuml -output diagram.puml ./path/to/your/go/code

goplantuml <DIR>