言語

PlantUML言語のシンタックスハイライトを実装したエディタが存在します(こちらを参照)。

しかし、PlantUML言語の定義は今もなお変更され続けているので、言語に新しいキーワードが追加されると、既存のプロダクトにとっては問題です。

コマンドラインの隠しオプションを使って、この問題を回避できます:

java -jar plantuml.jar -language

このコマンドは、標準出力に、PlantUML言語に関する簡単にパースできる記述を出力します:

;type
;10
abstract
actor
class
component
enum
interface
object
participant
state
usecase

;keyword
;43
@enduml
@startuml
activate
alt
[..]
up

;preprocessor
;6
!define
!endif
!ifdef
!ifndef
!include
!undef

;skinparameter
;145
ActivityArrowFontColor
ActivityArrowFontName
[..]
UsecaseStereotypeFontSize
UsecaseStereotypeFontStyle

;color
;140
AliceBlue
AntiqueWhite
Aqua
[..]
WhiteSmoke
Yellow
YellowGreen

;EOF

PlantUML言語を使って何かをする必要がある場合は、この出力を、その都度パースしてください。plantuml.jarの新しいバージョンがアップロードされるたびに、プロダクトを最新の状態にすることができます。

文法チェック

テキストが有効なPlantUMLの記述かどうかを確認したい場合、次のコマンドを使うことができます:

type mytext.txt | java -jar plantuml.jar -syntax

標準出力に、基本的な情報が出力されます。1行目には次のいずれかの単語が書かれています:SEQUENCESTATECLASSOBJECTACTIVITYUSECASECOMPONENTOTHERERROR

: (この場合、@startumlは省略可能です)

次のテキストを与えると、

Bob -> Alice : hello

出力は次のようになります:

SEQUENCE
(2 participants)

テキスト中にエラーが存在する場合、行番号とエラーの内容が表示されます:

actor Bob
actor Bob
Bob -> Alice : hello

出力は次のようになります:

ERROR
2
Duplicate participant : Bob