Atomのplantuml-viewerが良かった話

概要

仕事でクラス図書く必要があり、プレーンテキストで書けるものは無いかなと探していたところ、いい感じのやつがあったのでメモ。

望み
  • 簡単なUML図をササッと書きたい
  • プレーンテキストで書いてGitで管理したい
  • 図のレイアウト調整とか面倒
  • イメージをエクスポートしたい

すべて満たしていたもの⇣

github.com

これを使えば上記を満たしてUML図が書ける。

もともとPlantUML(http://plantuml.com/)っていうオープンソースプロジェクトがあり、上記Atomプラグインを使うと、それをリアルタイムプレビューしてくれる。良い。

インストール

OS:macOS Sierra 10.12.1
リポジトリのInstallに従ってゆく。

apm install plantuml-viewer

このままだとシーケンス図しか書けない。 ほかの図(ユースケース図、クラス図、状態遷移図など、種類はPlantUMLのページ参照) も書きたいときは、graphviz(http://www.graphviz.org/)をインストールする必要がある。

brew install graphviz

これで快適にUMLを書ける様になった。
PlantUMLの記述方法は本家URL参照。