/AEMComponentArchitectureGraph

Creates a component inheritance and composition diagram using GraphiViz

Primary LanguageScalaOtherNOASSERTION

AEM Component Architecture Graph

Why?

Building large AEM projects involves developing components between many developers. Often its a good idea to overlay other components. This extending action is hard to keep track of. This project allows you to create a diagram of inheritance and composition of components.

Requirements

  • Java 1.7+

  • GraphViz

    Must be runnable from the command line (dot -V)

    If using OS X and homebrew, then GraphViz can be installed using

    brew install graphviz

Usage

  1. Download the jar locally from the releases section

  2. Run the jar with the first argument being the component directory of your project

Example:

java -jar AEMComponentArchitectureGraph-0.2.jar ui.apps/src/main/jcr_root/apps/company/components

  1. Creates composition_graph.png and inheritance_graph.png in the local directory

Building Uber/Fat jar

Must have Activator installed and runnable from command line

activator --version should work

If on OS X and using Homebrew then activator can be install using

brew install typesafe-activator

Assembling the Fat/Uber jar with all dependancies included use

activator assembly

License

see LICENSE