@interrogate/plantuml-to-svg

Convert PlantUML markup to SVG using Docker or JAR-based rendering.

Quick reference

• Package: @interrogate/plantuml-to-svg
• Maintained by: interrogate-io
• Issues: GitHub Issues

Installation

npm install @interrogate/plantuml-to-svg

What is this?

A Node.js package that provides a flexible API for converting PlantUML diagrams into SVG format. It supports both Docker-based rendering using interrogate/plantuml-cli and direct JAR file execution.

When should I use this?

• When you need programmatic conversion of PlantUML to SVG in Node.js
• When you want flexibility between Docker and JAR-based rendering
• When building tools that process PlantUML diagrams
• As a dependency for other tools in the PlantUML ecosystem

Prerequisites

Choose your preferred rendering method:

Docker Method

• Docker installed and running
• Access to pull the interrogate/plantuml-cli image

JAR Method

• Java Runtime Environment (JRE) installed
• System requirements as specified in PlantUML's documentation

Usage

Basic conversion using Docker (default method):

import { convertToSvg } from "@interrogate/plantuml-to-svg"

const plantUmlMarkup = `
@startuml
A -> B: Hello
B -> A: World
@enduml
`

const svg = await convertToSvg(plantUmlMarkup)

Using JAR method explicitly:

const svgUsingJar = await convertToSvg(plantUmlMarkup, { method: "jar" })

API

convertToSvg(markup: string, options?: ConversionOptions): Promise<string>

Converts PlantUML markup to SVG format.

Options

• method: "docker" | "jar" - Rendering method (default: "docker")
• Additional options documentation coming soon

License

MIT © James Lafferty