umlwatcher

Simple script that watches one folder and places plantuml diagrams in another.

Getting ready

## get the repo
git clone git@github.com:dataloudlabs/umlwatcher.git

## get into the repo folder
cd umlwatcher

## install dependencies
npm install

Usage

The script will watch one folder and place the diagrams in another. The folders will be created by the script if they don't exist.

## will look for changes to *.uml files in ./input and render png images into ./result
$ node umlwatch.js -w ./input -r result --render-existing 

If you're in the repo folder, you can look into the uml_examples and play with them a bit.

$ node umlwatch.js -w ./uml_examples -r result

Or just render all of them at once.

$ node umlwatch.js -w ./uml_examples -r ./result --render-existing 

The diagrams will be put in the -r, --result-path. The script will also create a last_render.png file with the result of the last rendering in case you want to debug/inspect as you code along your diagrams.

Other examples...

## Will re-render all *.uml files currently in ./input.
## (And also) will look for changes to *.uml files in ./input and render png images into ./result
$ node umlwatch.js -w ./input -r result --render-existing 

## will look for changes to *.uml files in ./input and render png and svg images into ./result
$ node umlwatch.js -w ./input -r result --render-existing --svg

$ node umlwatch.js --help
> Usage: umlwatch [options]

  Options:

    -V, --version                    output the version number
    -w, --watch-path <input_path>    Path to watch for changes
    -r, --result-path <result_path>  Path to place the diagrams
    -m, --file-mask [mask]           File mask to watch in watch_path
    --png                            Render to png.
    --svg                            Render to svg.
    --render-existing                Render existing files in watch-path
    -h, --help                       output usage information

Credit

The uml_examples are mostly taken directly from the plantuml documentation. Some others are dotgraphs taken from the dot guide in the graphviz documentation.

This is mostly an util script making use of node-plantuml and plantuml-encode.