Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 821 Bytes

README.md

File metadata and controls

22 lines (16 loc) · 821 Bytes

TSUML

This simple tool creates a UML diagram from typescript modules. The idea started from tsviz and was adapted to get an overall view of dependencies and coupling in a typescript project.

Installation

You need to install GraphViz, including correctly added it to your PATH.

Usage

tsuml <switches> <sources filename/directory> <output.png>

Available switches:
  -d, dependencies: produces the modules dependencies diagram
  -r, recursive: include files in subdirectories (must be non-cyclic)
  -c, coupling: print classes with a high coupling in different colors (orange for warnings and red for problems).

In order to create a diagram for an entire project you simply type:

tsuml <projectPath> diagram.png