Git Product home page Git Product logo

pkgviz-go's Introduction

pkgviz-go

Go Report Card GoDoc

Generate a vizualization of a Go package's types.

This package is still v0. If you run into bugs, please report it in Issues โœ๐Ÿป

How does it work

pkgviz-go uses Go's type-checker to analyse a given go package, builds a graph of the types, writes it to DOT format, and generates an image of the graph using graphviz.

Installation

Ensure that you have graphviz installed:

  • MacOS: brew install graphviz
  • Windows: install the latest package from here
  • Linux: follow your distribution's instructions here

Then install the pkgviz command:

go install github.com/tiegz/pkgviz-go/cmd/pkgviz

Usage

pkgviz A_GO_PKGNAME

The graph image is output to out.png.

Examples:

pkgviz github.com/tiegz/pkgviz-go

pkgviz time

pkgviz-go's People

Contributors

tiegz avatar

Stargazers

Anne Thorpe avatar  avatar Lucia Cerchie avatar Mahendra Bishnoi avatar Jon Williams avatar Valerio Santinelli avatar Amir M Pirhosseinloo avatar Lucas Alexander Floriani avatar Nikita avatar Lubomir Anastasov avatar Alessio Biancalana avatar zbv avatar Hugo Lageneste avatar pj avatar Moritz Marquardt avatar Christian Muehlhaeuser avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

pjebs isgasho

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.