Skip to content

A program that produces a type diagram of a go language package.

License

Notifications You must be signed in to change notification settings

filmil/typediag

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

typediag: go type diagramming

typediag is a program that produces a type diagram of a go language package.

A type diagram is a graph that shows which types are used by which functions in the package. It can be used to understand the relationships between types in an unfamiliar API.

Here's a sample result of running typediag on itself.

Example diagram

Requirements

Needs the graphviz package to be installed on your machine. For example, on Ubuntu machines you can install it with:

sudo apt-get install graphviz

Installation instructions below assume go 1.11.

Installation

git install github.com/filmil/typediag/...

Use

typediag --path=/some/directory/containing/go/code --output=$HOME/out.png

About

A program that produces a type diagram of a go language package.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published