Zenn
😽

PlantUMLが動かなくなった話と解決方法【VSCode/Mac】

2024/11/29に公開
VS Code
PlantUML
macOS
tech

はじめに

ある日、VSCodeでPlantUMLのプレビューをしようと Option + D を押したところ、突然プレビューが動かなくなりました。具体的には以下のエラーが出ました：

Unrecognized option: -graphvizdot
Error: Could not create the Java Virtual Machine.
Error: A fatal exception has occurred. Program will exit.

Javaの問題かと思いきや、設定が原因だったようです。同じ状況に陥った方のために、解決方法をまとめました！

問題

  • PlantUMLプレビューが動かない。
  • -graphvizdot が認識されないエラーが発生。

解決手順

以下の手順で解決しました。

  1. Graphvizの確認
    PlantUMLはバックエンドでGraphvizを使用します。まず、Graphvizが正しくインストールされているか確認しました。
    ターミナルで以下を実行：
dot -V

Graphvizがインストールされていない場合、以下で再インストール：

brew install graphviz
  1. Javaの確認
    PlantUMLはJavaを利用します。Javaが動作しているか確認しました。
    以下をターミナルで実行：
java -version

Javaがインストールされていない場合、以下でインストール：

brew install openjdk

インストール後、環境変数を設定：

export JAVA_HOME=$(/usr/libexec/java_home)
export PATH=$JAVA_HOME/bin:$PATH
  1. VSCodeの設定を修正
    settings.json を編集して、PlantUMLの設定を修正しました。
    settings.json の開き方
  • Command + Shift + P でコマンドパレットを開く。
  • 「Preferences: Open Settings (JSON)」を選択。
    以下を追加
{
  "plantuml.java": "/usr/bin/java",
  "plantuml.graphviz_dot": "/opt/homebrew/bin/dot"
}

保存してVSCodeを再起動。

  1. プレビューを確認
    修正後、以下の手順でPlantUMLのプレビューが正常に動作することを確認しました。
  • ショートカットキー: Option + D
  • コマンドパレット: 「PlantUML: Preview Current Diagram」を選択。

補足

  • PlantUMLサーバーを利用する場合
    ローカル環境での設定が難しい場合、以下の設定でPlantUMLサーバーを利用する方法もあります。
{
  "plantuml.render": "PlantUMLServer",
  "plantuml.server": "http://www.plantuml.com/plantuml"
}
  • GraphvizやJavaが動かない場合
    正しく動作しない場合、再インストールやパスの設定を再確認してください。

まとめ

VSCodeでPlantUMLのプレビューが動かなくなった場合、以下を確認してください：

  • GraphvizとJavaが正しくインストールされているか。
  • settings.json でPlantUMLの設定が正しいか。

今回の修正で、無事にPlantUMLのプレビューが復活しました！同じトラブルで困っている方の参考になれば嬉しいです。

Discussion