[Mac OS, VSCode] PlantUML 확장(Extension) 설정 방법

시퀀스 다이얼 그램이나, 유즈 케이스 다이얼 그램 등 UML을 코드로 작성하는 PlantUML을 Mac OS의 VSCode에서 사용하기 위한 유용한 플러그인 및 설치 방법을 공유합니다.

Extension 설치

먼저 VSCode의 확장(Command + Shfit + X) 창을 열어서 마켓플레이스에서 plantuml로 검색합니다.

저는 이미 설치되어 있기 때문에 2개의 확장 프로그램이 설치 되어 있을 겁니다.

PlantUML v2.13.13 - 제작자: jebbs, Yog PlantUML Highlight v0.0.5 - 제작자: Yog

이 2개의 확장을 설치하시고 다음 단계를 수행하면 됩니다.

(확장 링크 통해서 바로 설치하셔도 됩니다.)

Yog PlantUML Highlight - Visual Studio Marketplace

PlantUML - Visual Studio Marketplace

plantuml.jar 설치

PlantUML 확장 설치만으로도 바로 사용은 가능합니다. 명령 팔레트를 통해서 바로 Preview 화면 보기를 하면 PlantUML 문법으로 작성된 문서에 대한 Preview가 가능합니다.

하지만, 먼가 수정을 하거나, 추가를 할 때마다 엄청 느리다는 게 느껴지죠, 실제 PlantUML 확장에서도 plantuml.jar 설정을 권장하고 있습니다. 로컬에 설치하고 사용하길 권장하는 거죠. 그렇지 않으면 원격지의 서버에서 변환을 해오는데, 공개된 서버다 보니 성능이 좋지는 않은 것 같습니다.

설정 방법은 매우 간단합니다. 특히 Mac 사용자라면 더욱 그렇고요. 명령어 몇 개만 금방 설치합니다.

brew를 통해서 설치할 거라서 명령어만 입력하고 기다리시면 됩니다.

일단 필수적으로 자바가 필요한데 이미 자바가 설치되어 있다면 설치하지 않고 넘어가셔도 됩니다.
자바가 필요하신 분은 아래 명령부터 시작하시면 됩니다.

brew cask info java
brew cask install java

그리고 PlantUML을 사용할 때 필수적으로 필요한 graphviz라이이브러리를 설치해야 합니다. 액티비티 다이어그램 그릴 때 필요하다고 하더군요.

brew install graphviz

마지막으로 PlantUML.jar 파일 설치만 해주시면 됩니다.

brew install plantuml

PlantUML 확장 설정

이제 plantuml.jar 파일 설치가 완료되었으니 PlantUML 확장에 plantuml.jar 정보를 입력하도록 하겠습니다.

VSCode의 설정창으로 이동해서 @ext:jebbs.plantuml 검색을 합니다.
검색 결과에서 밑으로 조금 내리면 Plantuml: Jar항목이 있습니다. 여기에 우리가 설치한 plantuml.jar 위치를 입력하면 됩니다.
brew 이용해서 동일하게 설치하셨다면 plantuml.jar 파일은 /usr/local/opt/plantuml/libexec/plantuml.jar 이렇게 입력하시면 됩니다. 그리고 한 가지 더 입력하셔야 하는데, 바로 Java 실행 위치입니다.
이 위치는 which java 명령으로 java 위치 검색하셔서 Plantuml: Java 항목에 입력하시면 됩니다.
아래 스크린샷 참고하세요.