baserCMS Documentation

Githubでこのページを編集

Home / 5 / ucmitz / etc / PlantUMLの利用方法

PlantUMLの利用方法

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

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

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

 

環境構築方法

1. Javaをインストール

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

2. Graphviz をインストール

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

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

3. gulp、gulp-puml をインストール

プロジェクトディレクトリの直下で npm を使ってインストールします。

npm install

 

gulp での監視方法

ドキュメントルートに移動して gulp コマンドを実行します。

gulp