KotlinによるIntelliJ Plugin開発で、道具箱に磨きをかけよう！

by Hiroshi Ito

Slide 1

Slide 1 text

KotlinによるIntelliJ Plugin開発で、道具箱に磨きをかけよう！ Kotlin Fest Reject Conference 2022 いとひろ（@itohiro73）

Slide 2

Slide 2 text

本日のアジェンダ ● 自己紹介 ● IntelliJ IDEAのプラグイン開発の概要 ● 実際にプラグインを作る手順を説明する（Hello World） ● プラグインデモ ● 実はこんなこともできます

Slide 3

Slide 3 text

自己紹介いとひろ@itohiro73 ソフトウェアエンジニア @ ログラス株式会社外資系証券会社で12年間エンジニアとして従事したのち、 FinTech系スタートアップ3社を経て現職。前職ではクラウドファンディングの会社で執行役員VP of Engineeringとしてエンジニア組織の統括 Eclipse Collections （旧GS Collections）元プロジェクトリード

Slide 4

Slide 4 text

本セッションの目的

Slide 5

Slide 5 text

道具箱に磨きをかけよう！ Kotlinで開発をしている皆さんは、IntelliJ IDEAあるいはAndroid StudioをIDEとして利用している方が多いのではないでしょうか。これらのIDEのベースとなっているThe IntelliJ Platformは、実はKotlinを用いて Plugin開発をすることができます。本セッションでは、聴いてくださった皆さんが、IntelliJのプラグイン開発を始めてみようかな、試してみようかなと思えるような知見やモチベーションを持ち帰っていただけると良いなと考えています

Slide 6

Slide 6 text

IntelliJ IDEAのプラグイン開発の概要

Slide 7

Slide 7 text

IntelliJ Pluginのタイプ典型的なIntelliJ Pluginとしては、以下のようなタイプに分類できます ● カスタム言語サポート ● フレームワークの統合 ● ツールの統合 ● UIのアドオン ● テーマ

Slide 8

Slide 8 text

タイプ1: カスタム言語サポートカスタム言語サポートPluginは、特定のプログラミング言語に対してのサポートを提供するプラグインです ● ファイル操作 ● 字句解析 ● シンタックスハイライト ● フォーマット ● インサイトとコード補完 ● 静的検査とクイックフィックス

Slide 9

Slide 9 text

タイプ2: フレームワークの統合フレームワークの統合をサポートするプラグインでは、フレームワーク特有の機能をサポートや、DSLの提供といった拡張を行いますプラグイン例: ● Spring Framework ● Ktor ● Jakarta EE

Slide 10

Slide 10 text

タイプ3: ツールの統合ツールの統合をサポートするプラグインでは、開発者が日常業務で活用するツールをIDE上で扱えるような拡張を行いますプラグイン例 ● Gradle ● Maven ● Git ● Docker

Slide 11

Slide 11 text

タイプ4: UIのアドオンこのカテゴリーのプラグインは、標準のユーザーインターフェースに様々な変更を加えますプラグイン例 ● Random Background

Slide 12

Slide 12 text

タイプ5: テーマ「テーマ」では、IntelliJ系のIDEの見た目をさまざま変更することができます。

Slide 13

Slide 13 text

Kotlinで実装されたIntelliJ Pluginの例既存のIntelliJ Pluginにも、Kotlinで実装されたものは多く存在します。オープンソースとして開発されているものも多いので、自作のPlugin実装においても参考になります ● IntelliJ Presentation Assistant ● Rust plugin for the IntelliJ Platform ● TeXiFy-IDEA ● Deno plugin

Slide 14

Slide 14 text

まずはなんと言ってもHello World

Slide 15

Slide 15 text

どうやって始めれば良い？ Plugin開発を始めるには、JetBrainsが提供しているPlugin Templateで始めると良いです。このテンプレートがすでにKotlin対応されています。 ● IntelliJ Platform Plugin Template

Slide 16

Slide 16 text

まずはテンプレートからリポジトリを作成

Slide 17

Slide 17 text

まずはテンプレートからリポジトリを作成

Slide 18

Slide 18 text

IntelliJ Plugin Templateのディレクトリ構造

Slide 19

Slide 19 text

このテンプレートはかなり親切にできてる

Slide 20

Slide 20 text

このテンプレートはかなり親切にできてる

Slide 21

Slide 21 text

このテンプレートはかなり親切にできてる

Slide 22

Slide 22 text

このテンプレートはかなり親切にできてる

Slide 23

Slide 23 text

このテンプレートはかなり親切にできてる

Slide 24

Slide 24 text

このテンプレートはかなり親切にできてる

Slide 25

Slide 25 text

しかし、クローンしてすぐ動かないので注意

Slide 26

Slide 26 text

ここからようやくHello World

Slide 27

Slide 27 text

Hello World: ①plugin.xmlにtoolWindow拡張ポイントを追加

Slide 28

Slide 28 text

Hello World: ②パネルにHello World表示するMyToolWindowFactoryを作成

Slide 29

Slide 29 text

Hello World: ③Run/Debugを走らせてみよう

Slide 30

Slide 30 text

Hello World: ④初回はIntelliJ Community Editionの同意が必要です

Slide 31

Slide 31 text

Hello World: ⑤新たなIntellJ IDEAインスタンスが立ち上がります

Slide 32

Slide 32 text

Hello World: ⑥プラグインがインストールされていることが確認できます

Slide 33

Slide 33 text

Hello World: ⑦任意のプロジェクトを開いて、Tool Windowを確認！！

Slide 34

Slide 34 text

IntelliJ Plugin Hello World ここまででTool Windowに”Hello World”を表示する簡単なプラグインを作成することができました。 Hello Worldのサンプルコードはこちらに ● https://github.com/itohiro73/intellij-plugin-kotlin-sample/tree/0.1.0

Slide 35

Slide 35 text

もう少し発展的なプラグインつくりたい

Slide 36

Slide 36 text

IntelliJ Pluginプロジェクト作成ウィザード（入口だけ）せっかくIntelliJ Pluginのテンプレートがあるので、このテンプレートをプロジェクトウィザードから作成するようなPluginを作ってみましょう。

Slide 37

Slide 37 text

IntelliJ Pluginプロジェクト作成ウィザード（入口だけ） JavaModuleBuilderという、Javaモジュールを作成するための既存ビルダーがあるので、こちらを活用します。JavaModuleBuilderが含まれるIntelliJ Platform Plugin であるcom.intellij.javaをgradle.properties（ビルド用）と、plugin.xmlの依存（ランタイム用）に追加しておきます。