Practical usage of PlantUML – §2. エディタのPlantUML拡張

PlantUMLを素のエディタで編集するのは苦痛なので、拡張機能をいくつか紹介します。Web検索でよく出てくるものでは、以下のものが有名どころでしょうか。

最後にあげたPlantUML EditorはWebサービスなので、とくにセットアップの必要はありません。とりあえず試したい場合に、利用してみるのがよいかと思います。

今回は、AtomVisual Studio CodeにPlantUML拡張を導入する手順を紹介します。ちなみに、環境はUbuntu 18.04 LTSで試していますが、エディタのインストール手順以外はWindowsでも同様にできると思います。

Visual Studio Code の PlantUML 拡張

ではまず、シェルから以下のコマンドを入力して、Visual Studio Codeをインストールしましょう(場合によっては、 curlコマンドがインストールされていない場合があるので、そのときは sudo apt install curl でインストールして下さい)。

続けて、以下のコマンドを入力します。

ここまでできれば、インストールが完了しているはずなので、スタートメニューから起動するか、シェルから code と入力してVisual Studio Codeを起動してください。

起動できたら、ウィンドウの左側にある拡張機能ボタンをクリックして下さい。

Figure 1

拡張機能のエクスプローラーが表示されるので、検索メニューから「PlantUML」と入力して、拡張機能を絞りこみます。絞り込みが出来たら、一覧の中の「PlantUML」をインストールして下さい。

Figure 2

では、ここまで出来たら拡張機能を使ってみましょう。適当にテキストファイルを作成して、Visual Studio Codeで開いて下さい。サンプルのクラス図として、以下のように記述して下さい(別に何でも構いませんが…)。

ここまで出来たら、Visual Studio Codeから[Alt + D]のショートカットを入力してください。以下のようにプレビューが表示されると思います。

Figure 3

Atom の PlantUML 拡張

続けて、AtomのPlantUML拡張を紹介します。まずは、Ubuntu 18.04 LTSAtomをインストールしましょう。ターミナルから以下のようにコマンドを入力して下さい。

インストールが完了したら、ターミナルから atom と入力するか、スタートメニューからAtomを起動して下さい。Atomが起動したら、メニューから[Edit]→[Preferences]を選択します。

Figure 4

続けて、[Install]メニューを選択し、検索欄に「PlantUML」を入力してパッケージを探します。検索が完了したら、plantuml-viewerをインストールして下さい(合わせて、language-plantumlもインストールしておくとよいでしょう)。

Figure 5

インストールが完了したら、plantuml-viewerの[Setting]のボタンをクリックして下さい。

Figure 6

設定画面が表示できたら、エンコードに【UTF-8】、Graphvizのインストール先【/usr/bin/dot】を入力して下さい。導入手順は、これで完了です。

Figure 7

ではお試しに、Visual Studio Code の拡張機能導入で作成したコードをAtomエディタで開いて、[Ctrl + Alt + P]のショートカットを入力して下さい。すると、以下のようにプレビュー画面が表示されると思います。

Figure 8

 

以上、簡単にですがPlantUMLの拡張機能の導入手順となります。ちなみに、この拡張機能を使用していれば、PlantUMLの本体であるjarファイルをダウンロードする必要はありません(JavaとGraphvizは必要です)。拡張機能自体がjarファイルを含んでいるので、もしプレビューで使用されているPlantUMLのバージョンを変えたい場合は、直接ファイルを置き換えるなどして対応して下さい。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください