assetviz

AssetViz

A command line web application source code visualization tool.

Installation

npm install assetviz

If you get installation errors for node-canvas, don't despair. It's an optional dependency used by Assetgraph to do some other cool stuff that isn't used in AssetViz.

Usage

$ assetviz [-h] [-v] [-r /path/to/webroot] [-o output.html] /path/to/webroot/index.html
$ google-chrome assetviz.html

The command line tool outputs an html-file called assetviz.html in the current working directory.

Arguments:

• Any number of html.files
• A path, assetviz will look for index.html in that path
• A minimatch pattern like path/to/webroot/**/*.html
• An URL (yes, you read that right)

Parameters:

-h : Help

-o : Output. The file name to output to. - pipes tp stdout. Defaults to ./assetviz.html if undefined.

-r : Root. Tells AssetViz which directory to treat as the web root. Only useful if you are graphing an html-file that has relations outside its own directory.

-v : Verbose. Includes inline assets in the output graph. If unset only inline elements relevant to describe file relations will be shown.

AssetViz output

The outputted graph html-file is called assetviz.html. It is a self contained file with no external dependencies, so you can upload it anywhere, email it or do whatever you want with it without worrying about dependencies or being online to view.

While viewing the graph you can use the mousewheel to zoom and click+drag to pan (google maps style navigation).

Future roadmap

• Improve text rendering
• Highlight relations on hover
• Relation direction with arrow heads
• Merge visualization template with grunt-dependencygraph

Thanks to

Andreas Lind Petersen for all his wonderful work on Assetgraph. We have barely scratched the surface of the potential this project has. Kenneth Auchenberg for his visualization work and revitalization of the source code visualization dream.

License

MIT