Skip to content

ZenUml/jetbrains-zenuml

Repository files navigation

jetbrains-zenuml

The ZenUML plugin running on the JetBrains IDEs.

This official extension integrates ZenUML directly into all JetBrains IDEs. It supports ZenUML diagram files with the extensions .z, .zen and .zenuml.

The editor uses an offline version of ZenUML renderer, therefore it works without an internet connection and content stays local in your IDE.

Free

  • Full support of ZenUML DSL
    • Sync and Async messages
    • Creation, Return/Reply messages
    • Alt, Loop, Par, try/catch/finally fragments
  • Live preview of your diagrams
  • Cloud and other common icons (EC2, Lambda, Database, Boundary, etc.)

Paid

Generate ZenUML diagram from Java code only on Intellij IDEA.

Hacking / reverse engineering

To enable DevTools,

  1. Open menu item Help > Find action... and search for "Registry..."
  2. Enable "ide.browser.jcef.contextMenu.devTools.enabled"

Development

  1. Java version: OpenJDK 11 or higher.

  2. ./gradlew

  3. ./gradlew runIde to start another instance of IDEA with our plugin installed.

    Using Gradle In IntelliJ

    If you get an error like this:

    Cause: org/openjfx/gradle/JavaFXPlugin has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0

    you need to change Build Tools > Gradle > Gradle JVM to version 11 or higher.

Release

  1. determine release version number in the format of YYYY.R.N, 2019.1.1 for example. N can be omitted for the first release of a major version.
  2. File resource/META-INF/plugin.xml line 4, update plugin version in <idea-plugin>.<version> with YYYY.R.N
  3. Pull request -> Merge to master
  4. git checkout master && git pull --reb
  5. git tag -a release-YYYY.R.N -m 'release tag msg'
  6. git push origin release-YYYY.R.N
  7. travis will release zenuml.zip to github in a few minutes

Publish

  1. Log on to Market place.
  2. Use github release file to upload.

Installation

  • Inside Jetbrains IDE

    • (Skip this for prod version) To install Alpha Versions

      Add https://plugins.jetbrains.com/plugins/alpha/list as plugin repository

    • Search for ZenUml, click install button then follow instructions to restart IDE

  • Install via plugin file

    1. Preferences > Plugins > setting > Install Plugin from disk.
    2. Choose the file to install.

Jetbrains Market Place

Not Sure how to use it for now, But might need it at a later time.