PlantUMLの利用方法

baserCMS の開発では、クラス図、ユースケース図、ドメインモデル図などのドキュメントの作成において PlantUML を利用しています。
また、その際のSVGファイルへの変換には plantuml.jar を利用しています。

変換の際は、src/puml/ 配下に作成した pumlファイルを元に、ドキュメントルート配下の同階層に出力します

/src/puml/5/svg/use_case/sample.puml
↓
/5/svg/use_case/sample.svg

環境構築方法

まず、Javaをインストールします。
https://java.com/ja/

次にグラフ画像に変換するツールである Graphvizをインストールします。

# Mac環境
brew install graphviz
sudo ln -s /opt/homebrew/bin/dot /usr/local/bin/dot

プロジェクトディレクトリの直下に plantuml.jar を配置します。

curl -JLO http://sourceforge.net/projects/plantuml/files/plantuml.jar/download

プロジェクトディレクトリの直下で変換用のスクリプトを実行します。

# 全ファイルを変換する場合
./bin/build-puml.sh

# 特定のファイルのみ変換する場合
./bin/build-puml.sh {PUMLFILE}

ファイルの変更を監視して自動で変換する場合は、fswatch をインストールした上で、監視用のスクリプトを実行します。

brew install fswatch
./bin/watch-puml.sh

ブラウザの自動リロードについては、docker compose up で起動する Jekyll のライブリロード機能により行われます。