PlantUML SD Multiline - VS Code Extension

Transform PlantUML sequence diagrams by merging inline comments into multiline action labels.

Features

✨ Automatic Transformation on Save – Your PUML files are automatically enhanced when you save them

🎨 Variable Highlighting – Variables in {{name}} format get bold/italic styling

📝 Preserves Original Comments – Comments are merged into labels while keeping the original lines

Usage

Automatic Transformation

The extension automatically transforms your .puml files when you save them (if enabled in settings).

Manual Transformation

Command Palette: PlantUML: Transform Current File
Context Menu: Right-click on a .puml file and select "PlantUML: Transform Current File"

Example

Before:

@startuml
App -> Service : processRequest
' Validates the incoming request
' Returns {{RequestId}} for tracking
@enduml

After:

@startuml
App -> Service : processRequest\n""Validates the incoming request""\n""Returns <b><i>{{RequestId}}</i></b> for tracking""
' Validates the incoming request
' Returns {{RequestId}} for tracking
@enduml

Extension Settings

This extension contributes the following settings:

pumlMultiline.transformOnSave: Automatically transform PUML files when saved (default: true)
pumlMultiline.formatVariables: Format {{variables}} with bold/italic styling (default: true)
pumlMultiline.addHeader: Add header comment to transformed files (default: false)

Requirements

This extension works best with PlantUML preview extensions like:

PlantUML

Known Issues

None currently. Please report issues on GitHub.

Release Notes

1.0.0

Initial release of PlantUML SD Multiline

Automatic transformation on save
Manual transformation via command palette
Configurable variable formatting
Optional header comments with GitHub link

More Information

For more details, examples, and documentation, visit:

License

MIT - see LICENSE

PlantUML SD Multiline

Henrik Zarsteck