go-dependency-graph

A tool to build dependency graph for go programs based on dependency injection functions.

Known issues

• External dependencies are ignored
• primitive types are not handled and will result in a weird result

Example

https://github.com/google/wire/blob/main/_tutorial/main.go

c4 plantuml component

@startuml
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml

title testdata/wire_sample

Container_Boundary(main, "main") {
Component(main.Greeter, "main.Greeter", "", "Greeter is the type charged with greeting guests.")
Component(main.Event, "main.Event", "", "Event is a gathering with greeters.")

}
Rel(main.Greeter, main.Message, main.Message)
Rel(main.Event, main.Greeter, main.Greeter)

@enduml

http://www.plantuml.com/plantuml/uml/RO_1QiGW48RlFeNDgO5klFJKOqFPInTAeUSmcmn6K2CwDYobxzvHaYvTUX3znfdlrplZHvidb3DHI4zAHLWxRMZEvvmmZeidzDIDYrF1WgVix27HPCrPzO-7jrBwEBqg1uamScde5nSMNsO2zmf1XYnAGXu20hMQY4C25omAqRCTZCSuF2_PJn0lzuxvGJPbQrhv9NvrzQOxHaGEsZfsR9ZBsb2Q96dcq4j0ESuGDKvovJz9NHgCrr9dVb3gclOsuEMJZxk-mYwlKDGWDR0-5i_LYh7gnBTuHtlps4edJ0aq_gNsshqb_pEvKIj-0000

mermaid class

classDiagram
main_Greeter ..> main_Message
main_Event ..> main_Greeter

Installation

go install github.com/emilien-puget/[email protected]

How to Use

Generator

go-dependency-graph --project=<path to project> --result=<result file> --generator=<generator>

Available generator are as follows

• c4_plantuml_component, the default value, more information about that format here : https://github.com/plantuml-stdlib/C4-PlantUML
• json, the struct parse.AstSchema encoded in JSON
• mermaid_class, a class diagram using mermaid syntax https://mermaid-js.github.io/mermaid/

With the result written to a file

go-dependency-graph --project=<path to project> --result=<result file>

With the result piped

go-dependency-graph --project=<path to project> > <piped>

GitHub

View Github