https://github.com/filmil/typediag

A program that produces a type diagram of a go language package.
https://github.com/filmil/typediag

diagram dot golang type

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/filmil/typediag
• Owner: filmil
• License: apache-2.0
• Created: 2018-10-11T09:34:48.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-16T05:43:40.000Z (over 6 years ago)
• Last Synced: 2025-01-25T07:28:26.813Z (3 months ago)
• Topics: diagram, dot, golang, type
• Language: Go
• Homepage:
• Size: 905 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](res/example.png)

# Requirements

Needs the [graphviz][1] package to be installed on your machine.  For example, 

on Ubuntu machines you can install it with:

```console

sudo apt-get install graphviz

```

Installation instructions below assume go 1.11.

# Installation

```console

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

```

# Use

```console

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

```

[1]: http://www.graphviz.org