A tool for reorganizing, restructuring, reformatting, and rendering FC4 diagrams.
This tool was created because when one uses Structurizr Express (SE) to position the elements of a diagram, SE regenerates the diagram source YAML in such a way that the YAML becomes noisy and the sorting can change. This makes the source harder to work with in a text editor and impossible to usefully diff from revision to revision — and without useful diffing it’s very difficult to do effective peer review.
So fc4-tool processes the YAML: cleans it up, applies a stable sort to all properties, removes empty properties, etc — so as to ensure that the changes applied in each revision are very small and specific and all extraneous changes are filtered out. This will hopefully enable effective peer review of revisions to the diagrams.
- “Snaps” the elements and vertices in a diagram to a virtual grid
- Renders diagrams
brew cask install adoptopenjdk
brew cask install chromium
MacOS quick-start for Homebrew users:
brew cask install adoptopenjdk chromium
mv ~/Downloads/fc4/fc4* ~/bin/
fc4 edit path/to/diagram.yaml/or/dir
git statusand you should see that the YAML file has been created/changed and its corresponding PNG file has also been created/changed