1.Planterって何？
- Merry Christmas!! おっさんサンタからの贈り物ですよ。
- PlantUMLサーバーと連携し、 GitLab/GitHubのイシュー、Markdownファイル等に埋め込まれたUML図を描画します。
- Chromeの拡張です。
- オープンソースです。(作者はほとんど時間がないので、適当な出来です。改善のお手伝いをください）
2.Planterが解決する問題
こんな方にオススメです。
- GitHub/GitLabのイシューやプルリク(MR)の議論でUML図を使いたい!!
- Markdownファイルに記載したPlantUMLの図をGitHubやGitLab上でも見たい。
詳しい方はgitlab.comのサーバーには既にPlantUMLが組み込まれており、Markdown記法でUMLを記載することが可能なことをご存知でしょう。しかし、オンプレミスで動作させているGitLabサーバーは複雑な設定をする必要がありますし、こちらで紹介したようなMarkdown Preview Enhancedプラグインで記載したUMLは見ることはできません。本稿は、こういった問題を解決します。
3.Planterの使い方
3.1.Planterのインストール
- Chrome拡張ストアに行きます。
こちらのリンクからPlanterをインストールします。
3.2.PlantUMLサーバーの設置
次にPlantUMLサーバーを立てます。Apache TomcatなどのJ2EEサーバーが必要です。tomcatのインストールはzipを解凍するだけです。
つぎにPlantUMLサーバーアプリのダウンロードです。以下から、warファイルをダウンロードしてください。
こちらのwarファイルをtomcatを解凍したwebappsの中にwarファイルをコピーします。
$ apache-tomcat
├── bin
├── webapps (ここにwarファイルをコピー)
....
その後、tomcatを解凍したbinフォルダの中のstartupで起動します。
>cd bin
>startup.sh
3.3.Planterの設定
chrome://extensionsを開き、オプションから設定をします。
Planterは標準でGitHub/GitLabを 本家のPlantUML でレンダリングするようになっています。標準でも動作をしないわけではないですが、本家PlantUMLサーバーはお試しとして、 必ず自前サーバーで設定して使用してください。
4.使ってみよう！
イシューやマークダウンファイルでUMLを記載してみましょう。以下のように記載します。
```plantuml
@startuml
PlantUMLのコンテンツ
@enduml
```
つまり、Markdown Preview Enhancedで記述したコードブロックを記載することができます。今までマークダウンで、いろいろなUMLを描いていると思いますが、それをGitLab/GitHub上で見ることが出来ます。
すると、
GitLab
GitHub
5.PlanterはOSSです。
PlanterはGitHub上に公開されたOSSです。GitHubのこちらをご参照ください。Planterは都元ダイスケさんのpegmatiteや小飼弾さんのjs-deflateによってなりたっています。(自分は見事に何もやってません。）その恩恵を皆さんと分かちあいたいと思います。雑な出来で何とかクリスマスに間に合ったレベルですが、皆さんのプルリクエストをお待ちしています。
個人的にもまだreloadしないとたまに画像が出ないとか少し直したいと思ってますが、ちょいちょい直してあげてください。