scaladiagrams

by mikeyhu

mikeyhu / scaladiagrams

Generate class diagrams from scala source code

127 Stars 33 Forks Last release: Not found MIT License 36 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Scala Diagrams

Scaladiagrams is a command line tool to generate DOT files representing a Scala projects class hierarchy. These DOT files can then be passed to a renderer such as GraphViz to draw the hierarchy.

Usage

First, compile and package with ./build

To run Scaladiagrams do the following:

scaladiagrams --source pathToScalaSourcefiles > dotFile

If you have Graphviz installed, you can generate an image like so:

scaladiagrams --source pathToScalaSourcefiles | dot -Tpng > file.png

Large class hierarchies are probably best rendered as an SVG file, just replace the -t target to svg.

Other options

./scaladiagrams --help
    -e, --extension      (default = .scala) 
    -l, --linked             only output types that extend other types 
    -p, --parent        only output parents of the named class 
    -s, --source        location of source files (default = .) 

Most useful of these are --linked and --parent; these both reduce the scope of the diagram to be produced.

Example diagram

Class Diagram

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.