Skip to content

Small helpers and macros for PlantUML in vscode

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE
Apache-2.0
LICENSE.txt
Notifications You must be signed in to change notification settings

michael72/plantuml-helpers

plantuml-helpers README

This is a small helper for editing PlantUML files.

codecov CircleCI

Sample

Features

Changes the arrows in Plant-UML diagrams from horizonatal to vertical and vice versa. It can also swap the arrow direction with also swapping the content. This is helpful when changing the order in which the elements are drawn.

Commands

The available commands are:

  • PlantUMLHelpers: Auto Format UML - will try to rearrange the currently selected UML diagram according to the following rules:
    • elements with no / less incoming dependencies are moved to the beginning
    • elements with many incoming dependencies are moved to the end
    • elements are ordered by chains
    • inheritance is set to use "up" direction (if not already set to "down")
    • composition is set to use "right" direction (if not already set to "left")

Supported diagram types are: * component + class diagrams * sequence diagrams - here the "sorting" is done by declaring the participants and actors in order

  • PlantUMLHelpers: Reformat UML is similar to auto format, however directions may all be changed and directions set by user are all overridden. Also if one source component points to several other components in the same direction the directions are automatically adjusted to point also up/down or left/right. This may already lead to good enough results.

Commands with key combinations are:

  • Alt-8: rotate arrow to left
  • Alt-9: swap arrow left / right
  • Alt-0: rotate arrow to right

Enjoy!