generating diagrams of the architecture described in tslint.json
The configuration of
tslint-folders-diagrams is a description of the architecture of your TypeScript project (see tslint.tslint-folders.json for an example).
tslint-folders-diagrams can generate dot files from its configuration. A dot file is a simple format to describe a graph of nodes.
If you install
graphviz, then you can generate image diagrams from those dot files.
So, you can automatically generate architecture diagrams from the same configuration that
tslint-folders-diagrams uses to validate the source code.
note: the example scripts output SVG files which are scalable and work with markdown and so work with gitlab, npmjs etc.
generating a graph image from tslint-folders-diagrams
./generate_graph_image <path to tslint.json>
- graphviz has been installed and 'dot' is available at the command line.
- the machine has an environment variable
TEMPpointing to a temporary files location.
notes for Windows
Windows + Q -> Environment variables.
Add this to the PATH environment variable:
C:\Program Files (x86)\Graphviz2.38\bin
dot.exe is reachable.
executing bash scripts on Windows
- use cmder (bash)
bash cheat sheet
graphviz color schemes
The default used is
graphviz in Visual Code
extension 'Graphviz Preview'