/plantuml4idea

Intellij IDEA plugin for PlantUML

Primary LanguageJavaApache License 2.0Apache-2.0

plantuml4idea

IntelliJ IDEA plugin for PlantUML

This plugin provides integration with popular PlantUML diagramming tool


Sponsored by


Manage pull requests and conduct code reviews in your IDE with full source-tree context. Comment on any line, not just the diffs. Use jump-to-definition, your favorite keybindings, and code intelligence with more of your workflow.
Learn More


Author: Eugene Steinberg

Contributors:

Features

  • PlantUML tool window renders PlantUML source code under caret in currently selected editor
  • Structure view, code navigation between declaration and usages, renaming
  • Supports multiple sources per file
  • Supports pagination and zoom
  • Can copy diagram to clipboard or export as PNG, EPS or SVG, ASCII Art
  • Caching and incremental rendering

Tips

  • PlantUML code must be inside @startuml and @enduml tags to be rendered.
  • To be able to generate many diagram types, you must have Graphviz installed on your machine. For Windows, use Development version, not Stable 2.38 - that one is very old. You have to select your OS/Release and then go in Artefact tab to get .exe file or zip. About screen tests your installation.

Developer notes

  • Project setup: gif mp4
    + add plugins\platform-images\lib\platform-images.jar to the SDK.
    Protip: use https://plugins.jetbrains.com/plugin/6844-useful-actions - Tools | Add Dependant Bundled Plugins to IntelliJ Platform Plugin SDK instead.
  • debug logs can be enabled by adding '#org.plantuml' and 'org.plantuml' to [Help | Debug Log Settings]
  • use Jetbrains JDK if normal JDK produces UI bugs

There are following branches:

master

  • Current production branch

grammar

  • old experimental syntax support - never finished
  • Grammar classes can be generated using tools/grammar-gen.sh
  • This script can run automatically when you run the plugin using "Plugin" Run/Debug configuration. Just add the script above as an external tool and make it run before the "Make" step.