[IntelliJ] 인텔리제이 플러그인 만들기

회사에서 업무 시작이 늦어지며 본 개발에 들어가기 전처리 작업을 하고 있었다.

아주 복잡한 작업은 아니지만 노가다성 작업이기 때문에 자꾸 자잘한 실수가 발생하고 무엇보다 손목이 너무 아파서...

조금이라도 번거로운 작업을 줄이기 위해 노력하고 있는 중이었다.

 

처음에는 노가다성 작업을 반자동화 하기 위해 처음에는 파이썬 파일을 만들었다.

그러나 파이참 등이 깔려있지 않은 동료분들이 계셨고, 그래서 html 파일로 파일을 변환했다.

이 html 파일을 공유하니 한 동료분께서 우리 직원들 모두 인텔리제이를 사용하니 플러그인으로 만들면 더 편할 것 같다는 제안을 해주셨다!

그렇게 생애 최초 인텔리제이 플러그인 만들기 도전을 시작했다.

 

---

 

 

IntelliJ IDEA 2023.3 버전 이상을 사용하고 있다면 Plugin DevKit 플러그인(플러그인 링크)을 설치해서 사용해야한다.

이게 없으면 New Project 창에서 IDE Plugin 항목이 뜨질 않는다

 

 

 

1. 프로젝트 생성

방법 1.  inltelliJ 에서 제공하는 템플릿 사용

GitHub - JetBrains/intellij-platform-plugin-template: Template repository for creating plugins for IntelliJ Platform

 

해당 템플릿 없이도 플러그인은 만들 수 있다.

그러나 이 템플릿은 프로젝트 스캐폴드와 CI를 미리 구성하고 적절한 문서 페이지에 영연결하는 등의 세팅이 기본적으로 되어있는 것 같아 보인다.

사용 방법은 깃헙 read me를 읽어보면 간략하게 나와있으니 참고하면 된다.

 

 

방법 2. 직접 프로젝트 생성하여 사용 (Plugin DevKit 활용)

제공되는 템플릿을 사용하면 처음보는 라이브러리들이 의존성으로 걸려들어왔다.

나의 경우엔 테스트 등의 의존성이 필요하지 않은 가벼운 기능을 제공하려고 했기 때문에 직접 프로젝트를 만들어 사용하는 것이 훨씬 낫겠다는 판단이 들었다.

 

New > New Project  > IDE Plugin 을 선택하여 새 프로젝트를 생성할 수 있다.

 

2. plugin.xml 설정

프로젝트를 생성하고나면 plugin.xml 이라는 낯선 파일이 하나 보인다.

이는 플러그인 설정이 담겨있는 설정 파일이다.

플러그인의 이름, 제작자, 액션 정의 등 플러그인과 관련된 설정이 모여있는 핵심 파일이다.

 

3. Action 클래스 생성

프로젝트 패키지에 우클릭하여 New> Plugin DevKit> Action 을 선택한다.

 

각각 항목에 대해 간단히 설명한다면 다음과 같다.

Action ID	액션의 id 값 (플러그인이름.액션아이디 형태가 추천됨)
Class Name	액션 클래스의 이름
Name	메뉴에 노출될 이름
Description	액션에 대한 설명 (필수X)
Groups	그룹 지정 ex) ToolsMenu를 선택하면 상단의 Tool 메뉴에서 보여짐 ex) EditorPopupMenu는 에디터창에서 우클릭 시 나타나는 팝업창에서 보여짐
Actions	지정한 그룹의 액션 목록 First/Last 선택 시 해당 그룹의 맨 앞 / 뒤에 위치 Before/After 선택 시 선택 액션의 바로 앞 / 뒤에 위치

 

OK를 누르면 AnAction 를 상속받는 클래스가 생성된다.

 

 

4. 동작 확인하기

상단의 Run Plugin 을 실행하면 IDE 창이 새로 켜지며 지정한 액션을 확인해볼 수 있다.

만일 Run Plugin 을 찾지 못하겠다면 Gradle>Tasks>intellij>runIde를 실행해도 된다.

 

 

---

 

출처

https://sg-choi.tistory.com/635

https://madplay.github.io/post/creating-intellij-plugin-project