README.md

tsviz

This simple tool creates a UML diagram from typescript modules.

Installation

npm install -g tsviz-cli

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

Usage

Cli

tsviz-cli <switches> <sources filename/directory> <output.png>

Available switches:
  -d, dependencies: produces the modules dependencies diagram
  -svg: output an svg file

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

tsviz-cli samples/ diagram.png

Library

You may also consume tsviz npm library in your project to obtain a digest of modules, classes, methods, etc, of a given typescript project.

npm install tsviz

import { getModules, getModulesDependencies } from "tsviz";

const tsConfigDir = "path/where/your/tsconfig/lives";

const modules = getModules(tsConfigDir);
...

const modulesDependencies = getModulesDependencies(tsConfigDir);
...