PlantUMLのインストール+Atom環境の構築メモ(Mac)

PlantUMLとは

PlantUMLは、簡単なテキストベースの記述から、クラス図やシーケンス図などが描くことができるツール

例えば、

Bob->Alice : hello

のような記述をすることで、下記のような図を簡単に生成することができる。

f:id:springwell:20180519220838p:plain

PlantUMLのインストール

PlantUMLを使うためには、追加でJava 8とgraphbizが必要になるので、インストールする。

Java8のインストール

https://www.java.com/ja/からダウンロードしてインストール

graphbizのインストール

brew install graphbiz

plantumlのインストール

brew install plantuml

PlantUMLの動作確認

cat > hoge.plantuml << "EOF"
@startuml
Bob->Alice : hello
@enduml
plantuml hoge.plantuml

を実行して、hoge.pngが作成できてたら成功

Atomのプレビュープラグイン

Atomでプレビューしながら作業したいのでプラグインを入れる。

qiitaなどを見ると「plantuml-viewer」を使っているものが多いけど、手元の環境ではうまく動作しなかった。 似たような「plantuml-preview」というプラグインがあったけど、こちらは使うことができた。

plantuml-previewのインストール

Preferences=>Install=>Search Packages から「plantuml-preview」を選択してインストールする。

plantuml-previewの設定

このプラグインを使うためには、PlantUMLのjarファイルの場所をプラグインに設定する必要がある。

PlantUMLのjarファイルの場所は下記のような感じで調べることができる

which plantuml
cat /usr/local/bin/plantuml
#!/bin/bash
GRAPHVIZ_DOT="/usr/local/opt/graphviz/bin/dot" exec java -jar /usr/local/Cellar/plantuml/1.2018.5/libexec/plantuml.jar "$@"

みたいになっているので、「/usr/local/Cellar/plantuml/1.2018.5/libexec/plantuml.jar」を

Preferences=>Packages=>plantuml-previewの「PlantUML Jar」の項目に設定して、

hoge.plantumlを開いた状態で、「ctrl+p」を入力して右側に表示されたら成功